[Assessment] Sentinel

[drsii]

Assessment Phase Q3 2015

Architect: @drsii Package Lead: @suwardany Quality Control: @brunogaspar Member Advocate: Position Open

Assessment is a member driven review of package issues and proposals. We weigh the pros and cons, discuss features, and formulate a general plan for the next major.minor version. Discussion is extended for 15 days.

Disclaimer: We're extending this period outside of our member only repositories. With the recent decision to open source Sentinel we find there may be further value, insight, and opportunity.

Help Support Sentinel version 3

http://igg.me/at/sentinel-open-source

Sentinel v3 WIP

• Core
  • API
• Implementations
  • Laravel
• Addons
  • Multi Tenancy
  • OAuth Server

    Core

• Refactor package to contain generic classes and logic
• Move all framework related implementations to bridge/implementation packages
• Determine an extensible add-on API to allow registration of custom add-ons to Sentinel
• Abstract areas of responsibility into separate add-ons
  • Sentinel Authorisations
  • Sentinel Activations
  • Sentinel Throttle
  • Sentinel Reminders
  • Sentinel Multi-tenancy ⁽¹⁾
  • Sentinel Server ⁽¹⁾
  • Sentinel Social ⁽¹⁾
  • Sentinel Expiring-Permissions ⁽¹⁾
  • Sentinel Unique-Passwords ⁽¹⁾
  • Sentinel Watch ⁽¹⁾
• Improved ACL to include resource handling
• Improved API
• Improved events
• Improved exceptions
• User impersonation

⁽¹⁾ Premium add-ons

API

Sentinel

Registration

• Sentinel::register(array $credentials, Closure $callback = null)

  Status

• Sentinel::check()
• Sentinel::guest()

  Authentication

  Regular

• Sentinel::authenticate($credentials, $remember = false, $login = true)
• Sentinel::authenticateAndRemember($credentials)
• Sentinel::stateless($credentials)
• Sentinel::login(UserInterface $user, $remember = false)
• Sentinel::loginAndRemember(UserInterface $user)
• Sentinel::logout(UserInterface $user = null, $everywhere = false)

  Basic

• Sentinel::basic()
• Sentinel::setRequestCredentials(Closure $requestCredentials)
• Sentinel::setBasicResponse(Closure $basicResponse)

  Checkpoints

• Sentinel::bypassCheckpoints(Closure $callback, $checkpoints = [])
• Sentinel::checkpointsStatus()
• Sentinel::enableCheckpoints()
• Sentinel::disableCheckpoints()
• Sentinel::addCheckpoint($key, CheckpointInterface $checkpoint)
• Sentinel::removeCheckpoint($key)

  Setters and getters

• Sentinel::getUserRepository()
• Sentinel::setUserRepository(UserRepositoryInterface $users)
• Sentinel::getRoleRepository()
• Sentinel::setRoleRepository(RoleRepositoryInterface $roles)
• Sentinel::getPersistenceRepository()
• Sentinel::setPersistenceRepository(PersistenceRepositoryInterface $persistences)
• Sentinel::getUserModel()
• Sentinel::setUserModel($model)
• Sentinel::getRoleModel()
• Sentinel::setRoleModel($model)
• Sentinel::getPersistenceModel()
• Sentinel::setPersistenceModel($model)

  Addons

• Sentinel::registerAddon(AddonInterface $addon)
• Sentinel::unregisterAddon(AddonInterface $addon)
• Sentinel::registeredAddons()

  User Repository

• Sentinel::getUserRepository()->findById($id)
• Sentinel::getUserRepository()->findByCredentials(array $credentials)
• Sentinel::getUserRepository()->findByPersistenceCode($code)
• Sentinel::getUserRepository()->recordLogin(UserInterface $user)
• Sentinel::getUserRepository()->recordLogout(UserInterface $user)
• Sentinel::getUserRepository()->validateCredentials(UserInterface $user, array $credentials)
• Sentinel::getUserRepository()->validForCreation(array $credentials)
• Sentinel::getUserRepository()->validForUpdate($user, array $credentials)
• Sentinel::getUserRepository()->create(array $credentials, Closure $callback = null)
• Sentinel::getUserRepository()->update($user, array $credentials)

  Role Repository

• Sentinel::getRoleRepository()->findById($id)
• Sentinel::getRoleRepository()->findBySlug($slug)
• Sentinel::getRoleRepository()->findByName($name)

  Persistence Repository

• Sentinel::getPersistenceRepository()->check()
• Sentinel::getPersistenceRepository()->findByPersistenceCode($code)
• Sentinel::getPersistenceRepository()->findUserByPersistenceCode($code)
• Sentinel::getPersistenceRepository()->persist(PersistableInterface $persistable, $remember = false)
• Sentinel::getPersistenceRepository()->storePersistence(PersistableInterface $persistable, $code)
• Sentinel::getPersistenceRepository()->persistAndRemember(PersistableInterface $persistable)
• Sentinel::getPersistenceRepository()->forget()
• Sentinel::getPersistenceRepository()->remove($code)
• Sentinel::getPersistenceRepository()->removePersistences($persistable)
• Sentinel::getPersistenceRepository()->flush(PersistableInterface $persistable, $forget = true)

  Implementations

  Discussion

• Handling add-ons and their implementations. (sentinel-social/sentinel-social-laravel for example)

---

Detailed functionalities

Add-ons

Creating an add-on

Add-ons must implement Cartalyst\Sentinel\Addons\AddonInterface

use Cartalyst\Sentinel\Addons\AddonInterface;

class ActivationsAddon implements AddonInterface
{
    public function getId()
    {
        return 'activations';
    }
}

Registering an addon

Addons can be registered by instantiating the addon class and passing it to the registerAddon method.

use Cartalyst\Sentinel\Addons\Activations\Activation;

$activations = new ActivationAddon;

Sentinel::registerAddon($activations);

Using an addon

Calling the addon identifier on Sentinel returns the addon class.

Sentinel::activations()->activate($user);

Sentinel::social()->getAuthorizationUrl('facebook', 'http://example.dev/oauth/callback');

Sentinel::uniquePasswords()->getAuthorizationUrl('facebook', 'http://example.dev/oauth/callback');

[iolson]

Possibly a Symfony 2 and Lumen official implentations? Just a thought to go along with the Laravel implentation. As said in your Sentinel campaign would be to move integrations into their own bridge packages.

[brunogaspar]

Lumen, yes. Symfony, not really sure, as it's quite overwhelming to write those bundle packages heh

[drsii]

Assessment period is reclosed.