Adding OKTA Single Sign-on Support - #568

There are some changes with sign-up and auto-login that we have not solved and could use your help.

You should never manually modify files in the vendor folder. All files in there come through composer and are maintained by their creator. These changes will get lost with every update of the dependecies. The vendor-folder is excluded from the repo since it can be recreated identically on every system thanks to composer. To use okta with bookstack there should be used a package that extends socialite like e.g. https://github.com/tequilarapido/socialite-okta (just googled, i have no experience with this package)

@ssddanbrown - Any info on this - I know we would love this merged into the main code branch.

@forescout-spollock Thanks for creating this pull request.

As @lommes has mentioned, The content in /vendor should not be altered directly and, at least for BookStack, should not be committed into git. Due to the vendor folder being added it makes looking through this very difficult.

Please could you open a new pull request without the /vendor folder committed so the changes are clear? If you need help moving custom code from /vendor just let me know.

Archive.zip
Gents, this is the only way we were able to get it to work is by modifying in /vendor. There is really very little to it, so let me post more comprehensive instructions and files directly here. If you need more let me know, happy to help. We just needed to move this forward, not proud of the code.

Modify .env

In the .env file, located in the root of the application, generally /var/www/boostack

Add the following stanza:

# OKTA Settings
OKTA_URL=https://fsu.okta.com/
OKTA_REDIRECT=http://bookstack.fsu.com/login/service/okta/callback
OKTA_CLIENT_ID=0oasdfsafsfsdfsf7
OKTA_CLIENT_SECRET=YH6asdfsadfsadfsadfsadf5

Add the OKTA Icon

Add the file okta.svg to {bookstack root}/resources/assets/icons

Add the Okta Provider file

Add the file OktaProvider.php to {bookstack root}/vendor/laravel/socialite/src/Two/

Edit the Services.php file

In {bookstack root}/config/services.php add the following:

    'okta' => [
    'url' => env('OKTA_URL'),
    'client_id' => env('OKTA_CLIENT_ID'),
    'client_secret' => env('OKTA_CLIENT_SECRET'),
    'redirect' => env('OKTA_REDIRECT'),
        'name'          => 'Okta',
    ],

Edit the SocialAuthServices file

In {bookstack root}/app/Services/SocialAuthService.php add to the variable $validSocialDrivers okta

protected $validSocialDrivers = ['google', 'github', 'facebook', 'slack', 'twitter', 'azure','okta'];

Edit the SocialiteManager file

In {bookstack root}/vendor/laravel/socialite/src/SocialiteManager.php add thefollowing:

    /** 
     * Build an OKTA provider instance


     *  
     */

    public function createOktaDriver()
    {
        $config = $this->app ['config'] ['services.okta'];
        $provider = $this->buildProvider ( 'Laravel\Socialite\Two\OktaProvider', $config );
        $provider->setOktaUrl ( $config ['url'] );

        return $provider;
    }

###Enable Registration through OKTA
In {bookstack root}/config/setting-defaults.php change registration-enabled to true

<?php

/**
 * The defaults for the system settings that are saved in the database.
 */
return [

    'app-name'        => 'BookStack',
    'app-logo' => '',
    'app-name-header' => true,
    'app-editor'      => 'wysiwyg',
    'app-color'       => '#0288D1',
    'app-color-light' => 'rgba(21, 101, 192, 0.15)',
    'app-custom-head' => false,
    'registration-enabled' => true,

];

Bookstack does not ship with a vendor folder. All these files are downloaded when composer install is run on the target system. Adding the vendor folder will bypass some basic features of composer (scanning for needed PHP extensions and versions). When adding files manually these changes have to be (manually) merged again on each update which is way less userfriendly than simply running composer install.

Since adding an additional socialite provider for okta seems to be a recurring request and the more providers BookStack supports the better, I will give this a shot and create pullrequest if it is achievebale in a proper way.

I now have a working version without adding vendor. Since there are no packages which are actively maintained and the one i mentioned before is built for laravel 5.1 and socialite 2 there are still several problems.

I tend to create an own provider from scratch for laravel 5.4+. Since it most likely would be exclusivly for bookstack and there now is a ticket to update bookstack to laravel 5.5, does it make sense to add a 5.4 compatible package now or wait for that update? It would be easier to fork the existing package and override it in composer.json using a custom repository which, in my opinion, is not a good practice for an app in production.

@ssddanbrown what's your opinion on this?

@lommes If you're creating a provider from scratch it's up to you how you like to integrate it really. I'll be upgrading master branch to 5.5 today if you were waiting for that (To start work on v0.19).

You can either have the provider in your own repo, Which we can bring in via composer or, if it's easier for you and you don't mind, You can just place the files in the services and/or provider folders within app if that's possible.

Thanks for your efforts so far on this.

I just added #598 so I think this can be closed.

Closing this now due to #598 being merged in.