Download the PHP package awallef/cakephp-cognito-auth without Composer

On this page you can find all versions of the php package awallef/cakephp-cognito-auth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package cakephp-cognito-auth

cakephp-cognito-auth plugin for CakePHP

This plugin allows you auth cognito users

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require awallef/cakephp-cognito-auth

Configure

From

Configure your auth component with your aws credentials & info

'loginAction' => false, // as u want
'unauthorizedRedirect' => false, // as u want
'checkAuthIn' => 'Controller.initialize', // depends where u want it
'storage' => 'Session', // as u want

// Authenticate
'authenticate' => [
    'Awallef/CognitoAuth.Form' => [

        // AWS - REQUIRED
        'region'  => 'eu-central-1',
        'credentials' => [
            'key' => 'XX',
            'secret'  => 'XX',
        ],
        'userPoolId' => 'eu-central-1_XX',
        'clientId' => 'XX',
        'clientSecret' => 'XX',

        // traditional stuff - OPTIONAL ( here default values )
        'fields' => [
            'username' => 'username',
            'password' => 'password'
        ],
        'userModel' => 'Users',
        'scope' => [],
        'finder' => 'all',
        'contain' => null,
        'passwordHasher' => 'Default',

        // create users - OPTIONAL ( here default values ) see User model below
        'create' => false,

        // Groups management - OPTIONAL ( here default values ) whether you want to keep an array or not
        'groupImplode' => true,
        'groupImplodeGlue' => ',',

        // renaming - OPTIONAL ( here default values + sepcial is_superuser )
        'fieldsMapping' => [
          'Username' => 'username',
          'Enabled' => 'is_active',
          'UserStatus' => 'status',
          'sub' => 'id',
          'Groups' => 'role',
          'new key' => 'is_superuser', // in order to use cakeDC/Auth
        ]

        // values functions - OPTIONAL ( default value is [] ) triggered after fieldsMapping (renaming)
        'valuesPostOperations' => [
            'role' => function($user, $value){
                return empty($user['role'])? 'no role': $user['role'];
            },
            'is_superuser' => function($user, $value){
                return (is_string($user['role']) && $user['role'] == 'superuser');
            },
        ],
    ],
]

Basic

Configure your auth component with your aws credentials & info

'loginAction' => false,
'unauthorizedRedirect' => false,
'checkAuthIn' => 'Controller.initialize',
'storage' => 'Memory', // means you ask aws for each query... so I suggest you to use my plugin cakephp-redis

/* so once Basic grant access, you'll find X-Token header with your token
* then add this X-Token hader with value Bearer XXX ( the previous token )
* so storage keep you session in redis instead of asking for new grant access
'storage' => [
    'className' => 'Awallef/Redis.Redis',
    'redis' => [
        'prefix' => 'your_app_id:token:',
    ]
],
*/

// Authenticate
'authenticate' => [
    'Awallef/CognitoAuth.Basic' => [

        // AWS - REQUIRED
        'region'  => 'eu-central-1',
        'credentials' => [
            'key' => 'XX',
            'secret'  => 'XX',
        ],
        'userPoolId' => 'eu-central-1_XX',
        'clientId' => 'XX',
        'clientSecret' => 'XX',

        // traditional stuff - OPTIONAL ( here default values )
        'fields' => [
            'username' => 'username',
            'password' => 'password'
        ],
        'userModel' => 'Users',
        'scope' => [],
        'finder' => 'all',
        'contain' => null,
        'passwordHasher' => 'Default',

        // create users - OPTIONAL ( here default values ) see User model below
        'create' => false,

        // Groups management - OPTIONAL ( here default values ) whether you want to keep an array or not
        'groupImplode' => true,
        'groupImplodeGlue' => ',',

        // renaming - OPTIONAL ( here default values + sepcial is_superuser )
        'fieldsMapping' => [
          'Username' => 'username',
          'Enabled' => 'is_active',
          'UserStatus' => 'status',
          'sub' => 'id',
          'Groups' => 'role',
          'new key' => 'is_superuser', // in order to use cakeDC/Auth
        ]

        // values functions - OPTIONAL ( default value is [] ) triggered after fieldsMapping (renaming)
        'valuesPostOperations' => [
            'role' => function($user, $value){
                return empty($user['role'])? 'no role': $user['role'];
            },
            'is_superuser' => function($user, $value){
                return (is_string($user['role']) && $user['role'] == 'superuser');
            },
        ],
    ],
]

User Model

you can create a copy of the user in your system by setting create config argument to true

// auth settings
...
// create users - OPTIONAL
'create' => true,
...

So you will need a User Model that matches aws fields or by using fieldsMapping argument congito-auth needs to have write permission on id if you rename AWS 'sub' filed into id

// auth settings
...
'fieldsMapping' => [
    'Username' => 'username',
    'Enabled' => 'is_active',
    'UserStatus' => 'status',
    'sub' => 'id',
    'Groups' => 'role'
],
...

Model Entity:

protected $_accessible = [
    '*' => true,
    'id' => true
];

Challenge

if you recieve a challenge error such as:

SMS_MFA
PASSWORD_VERIFIER
ADMIN_NO_SRP_AUTH
NEW_PASSWORD_REQUIRED

redirect, or ask user to provide responses in request data object:

// + username + password => required 
// 'USERNAME' and 'SECRET_HASH' => will be filled for you
$request->data['Challenge']['responses'] // must be filled

please refer to : aws php SDK #adminrespondtoauthchallenge


All versions of cakephp-cognito-auth with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.9
cakephp/cakephp Version ^3.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package awallef/cakephp-cognito-auth contains the following files

Loading the files please wait ....