diff options
Diffstat (limited to 'doc/en_US/plugin-authentication.markdown')
| -rw-r--r-- | doc/en_US/plugin-authentication.markdown | 40 |
1 files changed, 0 insertions, 40 deletions
diff --git a/doc/en_US/plugin-authentication.markdown b/doc/en_US/plugin-authentication.markdown deleted file mode 100644 index e1ca6f01..00000000 --- a/doc/en_US/plugin-authentication.markdown +++ /dev/null @@ -1,40 +0,0 @@ -Authentication Plugin -===================== - -New authentication backends can be written with very few lines of code. - -Provider Registration ---------------------- - -In the method `initialize()` of your plugin, call the method `register()` of the class `AuthenticationManager`: - -```php -public function initialize() -{ - $this->authenticationManager->register(new ReverseProxyLdapAuth($this->container)); -} -``` - -The object provided to the method `register()` must implement one of the pre-defined authentication interfaces. - -Those interfaces are defined in the namepsace `Kanboard\Core\Security`: - -- `Kanboard\Core\Security\PreAuthenticationProviderInterface` -- `Kanboard\Core\Security\PostAuthenticationProviderInterface` -- `Kanboard\Core\Security\PasswordAuthenticationProviderInterface` -- `Kanboard\Core\Security\OAuthAuthenticationProviderInterface` - -The only requirement is to implement the interfaces, you class can be written the way you want and located anywhere on the disk. - -User Provider -------------- - -When the authentication is successful, your driver must return an object that represents the user. -This object must implement the interface `Kanboard\Core\User\UserProviderInterface`. - -Example of authentication plugins ---------------------------------- - -- [Authentication providers included in Kanboard](https://github.com/kanboard/kanboard/tree/master/app/Auth) -- [Reverse-Proxy Authentication with LDAP support](https://github.com/kanboard/plugin-reverse-proxy-ldap) -- [SMS Two-Factor Authentication](https://github.com/kanboard/plugin-sms-2fa) |