Hello there!

Need Help? We are right here!

miniOrange Email Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com

GhostJS Single Sign-On (SSO)


GhostJS SSO (Single Sign On) allows your users to log into GhostJS with your Identity Provider credentials. IT admins can easily manage user access activities and grant or revoke SSO access to GhostJS application. This is done using JSON Web Token (JWT) tokens and it can be easily integrated with GhostJS built in any framework or language. The following document contains instructions on how to connect your GhostJS application to the miniOrange application using a JWT token. This allows you to add SSO, 2FA, or MFA to your GhostJS application in very easy steps

In case you need our help with the integration or setup proces, feel free to reach out idpsupport@xecurify.com

Prerequisites

  • Download the JWT Connector.
  • Extract and copy the jwt-connector folder to the source folder of your app.
  • Install the dependencies with the following command.
  • npm install --save base64url jsrsasign jssha utf8

Follow the Step-by-Step Guide given below for Single Sign-On (SSO)

1.Configure GhostJS in miniOrange

  • Login to miniOrange Dashboard and click on Apps >> Add an Application.
  • GhostJS Single Sign-On (SSO) add app

  • Click on Create App button in JWT box.
  • GhostJS Single Sign On SSO add app

  • In the next step, search for your application from the list, if your application is not found. Search for External / JWT App and you can set up your Application.
  • GhostJS SSO (Single Sign-On): external app

  • Enter the name of your application and the redirect URL to the page where the JWT token is verified and click on Save.
  • GhostJS SSO (Single Sign-On): redirect url

  • Custom App Name: The name of your Ghost application.
  • Redirect-URL: https://<your_ghostjs_domain>/members/?action=signin
  • Identity Source (optional): You need to select the user store or the external IDP where the user accounts will be stored
  • If you click on edit for your application you can see the Single Sign-On URL. You will need this URL in the following steps so save it accordingly
  • GhostJS SSO (Single Sign-On): select edit

    GhostJS SSO (Single Sign-On): endpoints

  • You can download the certificate by clicking on ‘certificate’ in the options of your application. You will need the certificate in the following steps.
  • GhostJS SSO (Single Sign-On): select certificates

2.Configure SSO in GhostJS

  • In \content\themes\casper\default.hbs file you can add a custom SSO button in the div class ‘gh-head-actions’
  • {{#if @site.members_enabled}}
                    {{#unless @member}}
                    <a class="gh-head-button" href= '<YOUR SSO URL>',
                        //"https://loginxyz.xecurify.com/moas/broker/login/jwt/273903?client_id=vk
                        rLa5jmY0kChu4a&redirect_uri=http://localhost:2368/members/?action=signin",
                        >MiniOrange SSO</a>
    
    {{/if}}
            
  • In place of the link in href-tag, you can replace it with your SSO URL. You can get this SSO URL from step 7 of Configure your application in miniOrange.
  • In \node_modules\@tryghost\members-api\lib\MembersAPI.js add the following function. You need to add your x509 certificate that you can get from step 8 of configure your application in miniOrange.
  • const JWTBuilder = require("./jwt-connector/JWTBuilder");
                const cert = "< PLACE YOUR CERTIFICATE STRING HERE >";
                var verified = false;
    
                async function getMemberDataFromSSOToken(jwt) {
                    if(jwt) {
                        //Initialize the JWT
                        var jwtBuilder = new JWTBuilder.default;
                        jwtBuilder.parseJwt(jwt);
    
                        // set the secret that was shared by your IDP
                        jwtBuilder.setSecret(cert);
                        try {
                            //Compare the hashed jwt with the one received 
                            verified = jwtBuilder.verifyJwt();
                        } catch (error) {
                            console.error(error);
                        }
                        if (verified) {
                            // once you find the JWT is verified, you can go ahead and get the data from JWT
                            let user = jwtBuilder.getPayload();
                            if (!user) {
                                return null;
                            }
                            let email = user["email"];
                            let name = user["first_name"] + user["last_name"];
                            let labels = [];
                            let newsletters = [];
                            const member = await getMemberIdentityData(email);
    
                            if(member) {
                                await MemberLoginEvent.add({ member_id: member.id });
                                return member;
                            }
                            const newMember = await users.create({
                                name,
                                email,
                                labels,
                                newsletters,
                            });
                            await MemberLoginEvent.add({ member_id: newMember.id });
                            return getMemberIdentityData(email);
                        }
                    }
                    return null;
                }
            
  • Make sure to add the function in return variables at the bottom of the page.
  • return {
            middleware,
            getMemberDataFromMagicLinkToken,
            getMemberDataFromSSOToken,
            getMemberIdentityToken,
            ...    
            };
  • \node_modules\@tryghost\members-ssr\lib\MembersSSR.js add the following 2 functions
  • /**
            * @method _getMemberDataFromSSOToken
            *
            * @param {JWT} token
            *
            * @returns {Promise} member
            */
            async _getMemberDataFromSSOToken(token) {
                const api = await this._getMembersApi();
                return api.getMemberDataFromSSOToken(token);
            }
    
            /**
                * @method exchangeSSOTokenForSession
                * @param {Request} req
                * @param {Response} res
                *
                * @returns {Promise} The member the session was created for
                */
            async exchangeSSOTokenForSession(req, res) {
                if (!req.url) {
                    return Promise.reject(new BadRequestError({
                        message: 'Expected token param containing JWT'
                    }));
            }
    
            const {query} = parseUrl(req.url, true);
            if (!query || !query.id_token) {
                return Promise.reject(new BadRequestError({
                    message: 'Expected token param containing JWT'
                }));
            }
    
            const token = Array.isArray(query.id_token) ? query.id_token[0] :
            query.id_token;
            const member = await this._getMemberDataFromSSOToken(token);
            
            // perform and store geoip lookup for members when they log in
            if (!member.geolocation) {
                try {
                    await this._setMemberGeolocationFromIp(member.email, req.ip);
            } catch (err) {
                    // no-op, we don't want to stop anything working due to
                    // geolocation lookup failing
                    debug(`Geolocation lookup failed: ${err.message}`);
                }
            }
    
            this._setSessionCookie(req, res, member.email);
            return member;
            }
  • /core/server/services/members/middleware.js add the following function
  •         const createSessionFromSSOLink = async function (req, res, next) {
                if (!req.url.includes("id_token=")) {
                    return next();
                }
            // req.query is a plain object, copy it to a URLSearchParams object
            so we can call toString()
            const searchParams = new URLSearchParams("");
            Object.keys(req.query).forEach((param) => {
                // don't copy the id_token param
                if (param !== "id_token") {
                    searchParams.set(param, req.query[param]);
                }
            });
    
            try {
            const member = await
            membersService.ssr.exchangeSSOTokenForSession(req,res);
            const subscriptions = (member && member.subscriptions) || [];
            const action = req.query.action;
    
            if (
                action === "signup" ||
                action === "signup-paid" ||
                action === "subscribe"
            ) {
            let customRedirect = "";
            const mostRecentActiveSubscription = subscriptions
                .sort((a, b) => {
                    const aStartDate = new Date(a.start_date);
                    const bStartDate = new Date(b.start_date);
                    return bStartDate.valueOf() - aStartDate.valueOf();
                })
            .find((sub) => ["active", "trialing"].includes(sub.status));
            if (mostRecentActiveSubscription) {
            customRedirect =
            mostRecentActiveSubscription.tier.welcome_page_url;
            } else {
              const freeTier = await models.Product.findOne({ type: "free" });
              customRedirect = (freeTier && freeTier.get("welcome_page_url")) ||
            "";
            }
            if (customRedirect && customRedirect !== "/") {
                const baseUrl = urlUtils.getSiteUrl();
                const ensureEndsWith = (string, endsWith) =>
                    string.endsWith(endsWith) ? string : string + endsWith;
                const removeLeadingSlash = (string) => string.replace(/^\//, "");
                const redirectUrl = new URL(
                    removeLeadingSlash(ensureEndsWith(customRedirect, "/")),
                    ensureEndsWith(baseUrl, "/")
            );
    
            return res.redirect(redirectUrl.href);
            }
            }
            // Do a standard 302 redirect to the homepage, with success=true
            searchParams.set("success", true);
            res.redirect(`${urlUtils.getSubdir()}/?${searchParams.toString()}`);
            } catch (err) {
              logging.warn(err.message);
    
            // Do a standard 302 redirect to the homepage, with success=false
                searchParams.set("success", false);
                res.redirect(`${urlUtils.getSubdir()}/?${searchParams.toString()}`);
                }
            };
  • Make sure to add the function in module.exports variables at the bottom of the page.
  • module.exports = {
                loadMemberSession,
                createSessionFromMagicLink,
                createSessionFromSSOLink,
                ...
                };
  • /core/server/web/members/app.js add the following line above ‘membersApp.use(middleware.createSessionFromMagicLink);’ in line 27
  • membersApp.use(middleware.createSessionFromSSOLink);
  • Your application now supports SSO via the miniOrange userstore. You can also add 2FA, MFA or authentication via external IDP or userstore by adding the configuration in the miniOrange Admin Console. You can follow the documentation at https://developers.miniorange.com/docs/idp/

3. Test SSO Configuration

Test SSO login to your GhostJS account with miniOrange IdP:

Using IDP Initiated Login

  • Login to miniOrange IdP using your credentials.
  • GhostJS Single Sign-On (SSO) login

  • On the Dashboard, click on GhostJS application which you have added, to verify SSO configuration.
  • GhostJS Single Sign-On (SSO) verify configuration


Not able to configure or test SSO?


Contact us or email us at idpsupport@xecurify.com and we'll help you setting it up in no time.


4. Configure Your User Directory (Optional)

miniOrange provides user authentication from various external sources, which can be Directories (like ADFS, Microsoft Active Directory, Azure AD, OpenLDAP, Google, AWS Cognito etc), Identity Providers (like Okta, Shibboleth, Ping, OneLogin, KeyCloak), Databases (like MySQL, Maria DB, PostgreSQL) and many more. You can configure your existing directory/user store or add users in miniOrange.



  • To add your users in miniOrange there are 2 ways:
  • 1. Create User in miniOrange

    • Click on Users >> User List >> Add User.
    • GhostJS VPN 2FA : Add user in miniOrange

    • Here, fill the user details without the password and then click on the Create User button.
    • GhostJS MFA: Add user details

    • After successful user creation a notification message "An end user is added successfully" will be displayed at the top of the dashboard.
    • GhostJS Two-Factor Authentication: Add user details

    • Click on On Boarding Status tab. Check the email, with the registered e-mail id and select action Send Activation Mail with Password Reset Link from Select Action dropdown list and then click on Apply button.
    • GhostJS 2FA: Select email action

    • Now, Open your email id. Open the mail you get from miniOrange and then click on the link to set your account password.
    • On the next screen, enter the password and confirm password and then click on the Single Sign-On (SSO) reset password button.
    • GhostJS Multi-Factor Authentication: Reset user password
    • Now, you can log in into miniOrange account by entering your credentials.

    2. Bulk Upload Users in miniOrange via Uploading CSV File.

    • Navigate to Users >> User List. Click on Add User button.
    • GhostJS 2FA: Add users via bulk upload

    • In Bulk User Registration Download sample csv format from our console and edit this csv file according to the instructions.
    • GhostJS Two-Factor authentication: Download sample csv file

    • To bulk upload users, choose the file make sure it is in comma separated .csv file format then click on Upload.
    • GhostJS 2FA : Bulk upload user

    • After uploading the csv file successfully, you will see a success message with a link.
    • Click on that link you will see list of users to send activation mail. Select users to send activation mail and click on Send Activation Mail. An activation mail will be sent to the selected users.
  • Click on External Directories >> Add Directory in the left menu of the dashboard.
  • GhostJS 2FA: Configure User Store

  • Select Directory type as AD/LDAP.
  • GhostJS 2FA: Select AD/LDAP as user store

    1. STORE LDAP CONFIGURATION IN MINIORANGE: Choose this option if you want to keep your configuration in miniOrange. If active directory is behind a firewall, you will need to open the firewall to allow incoming requests to your AD.
    2. STORE LDAP CONFIGURATION ON PREMISE: Choose this option if you want to keep your configuration in your premise and only allow access to AD inside premises. You will have to download and install miniOrange gateway in your premise.
    3. GhostJS Two-Factor Authentication : Select ad/ldap user store type

  • Enter LDAP Display Name and LDAP Identifier name.
  • Select Directory Type as Active Directory.
  • Enter the LDAP Server URL or IP Address against LDAP Server URL field.
  • Click on Test Connection button to verify if you have made a successful connection with your LDAP server.
  • GhostJS MFA/2FA: Configure LDAP server URL Connection

  • In Active Directory, go to the properties of user containers/OU's and search for Distinguished Name attribute.
  • GhostJS MFA: Configure user bind account domain name

  • Enter the valid Bind account Password.
  • Click on Test Bind Account Credentials button to verify your LDAP Bind credentials for LDAP connection.
  • GhostJS MFA: Check bind account credentials

  • Search Base is the location in the directory where the search for a user begins. You will get this from the same place you got your Distinguished name.
  • GhostJS 2FA : Configure user search base

  • Select a suitable Search filter from the drop down menu. To use custom Search Filter select "Write your Custom Filter" option and customize it accordingly.
  • GhostJS MFA/2FA : Select user search filter

  • You can also configure following options while setting up AD. Enable Activate LDAP in order to authenticate users from AD/LDAP. Click on the Save button to add user store.
  • GhostJS MFA : Activate LDAP options

    Here's the list of the attributes and what it does when we enable it. You can enable/disable accordingly.

    Attribute Description
    Activate LDAP All user authentications will be done with LDAP credentials if you Activate it
    Sync users in miniOrange Users will be created in miniOrange after authentication with LDAP
    Fallback Authentication If LDAP credentials fail then user will be authenticated through miniOrange
    Allow users to change password This allows your users to change their password. It updates the new credentials in your LDAP server
    Enable administrator login On enabling this, your miniOrange Administrator login authenticates using your LDAP server
    Show IdP to users If you enable this option, this IdP will be visible to users
    Send Configured Attributes If you enable this option, then only the attributes configured below will be sent in attributes at the time of login

  • Click on Save. After this, it will show you the list of User stores. Click on Test Connection to check whether you have enter valid details. For that, it will ask for username and password.
  • GhostJS 2FA: Test AD/Ldap connection

  • On Successful connection with LDAP Server, a success message is shown.
  • Click on Test Attribute Mapping.
  • GhostJS LDAP successful connection

  • Enter a valid Username. Then, click on Test. Mapped Attributes corresponding to the user are fetched.
  • GhostJS MFA: Fetch mapped attributes for user

  • After successful Attribute Mapping Configuration, go back to the ldap configuration and enable Activate LDAP in order to authenticate users from AD/LDAP.
  • Refer our guide to setup LDAPS on windows server.

User Import and Provisioning from AD

  • Go to Settings >> Product Settings in the Customer Admin Account.
  • MFA/Two-Factor Authentication(2FA) for   miniOrange dashboard

  • Enable the "Enable User Auto Registration" option and click Save.
  • MFA/Two-Factor Authentication(2FA) for   Enable User Auto Registration

  • (Optional) To send a welcome email to all the end users that will be imported, enable the "Enable sending Welcome Emails after user registration" option and click Save.
  • MFA/Two-Factor Authentication(2FA) for   Enable sending Welcome Emails after user registration

  • From the Left-Side menu of the dashboard select Provisioning.
  • MFA/Two-Factor Authentication(2FA) for   User Sync/Provisioning

  • In Setup Provisioning tab select Active Directory in the Select Application Drop Down.
  • Toggle the Import Users tab, click on Save button.
  • MFA/Two-Factor Authentication(2FA) for   User Sync Active Directory Configuration

  • On the same section, switch to Import Users section.
  • Select Active Directory from the dropdown and click on the Import Users tab, to import all the users from Active Directory to miniOrange.
  • MFA/Two-Factor Authentication(2FA) for   User Sync Import Operation

  • You can view all the Users you have imports by selecting Users >> User List from Left Panel.
  • MFA/Two-Factor Authentication(2FA) for   User List

  • All the imported users will be auto registered.
  • These groups will be helpful in adding multiple 2FA policies on the applications.

miniOrange integrates with various external user sources such as directories, identity providers, and etc.

Not able to find your IdP or Need help setting it up?


Contact us or email us at idpsupport@xecurify.com and we'll help you setting it up in no time.



5. Single Logout

If you want to ensure that all sessions (SP and IDP) for a user are properly closed, you can configure Single Logout with the steps below.

A. Configure miniOrange with IdP SLO endpoint:

  • Go to the Identity Provider tab and edit the configured Identity Provider.
  • Find the option Single Logout URL and configure the SLO URL provided by your IdP.
  • GhostJS adfs sso single logout url

B. Configure IdP with miniOrange SLO endpoint:

  • Configure your Identity Provider with below Single logout endpoint.
    https://login.xecurify.in/moas/broker/login/saml_logout/<your-customer-id>
  • You can find the SSO Binding option to configure the logout binding type to either REDIRECT or POST.

C. Configure your JWT application with SLO endpoint:

  • Configure your JWT application with below Single logout endpoint.
    https://login.xecurify.in/moas/broker/login/jwt/logout/<your-customer-id>?redirect_uri=<redirect-url>



Want To Schedule A Demo?

Request a Demo
  


Our Other Identity & Access Management Products