PHP API

Two-Factor Authentication with SecSign ID Plugin

Use SecSign ID PHP two factor authentication on your PHP project with an easy and highly secure user login using iOS or Android mobile devices as well as for desktop use.

Find out why our Two-Factor Authentication is the best, some key-facts for developers and why you should upgrade to SecSign for your business.

Learn more about the options of on-premise use and your own customized ID App in your corporate design.

Download the plugin as cloud version for a free and convenient protection.

Table of contents

    Start right now! Questions?

    Feel free to get in touch with us if you need help setting up your SecSign ID plugin or to request a plugin for a not yet supported environment.
    CONTACT US

    In the PHP API archive next to the API-class ‘SecSignIDApi.php’ you will also find a fully functional example in PHP. Furthermore, you can find all PHP source codes on the SecSign GitHub page.

    The actual range of the API consists only of two classes with which the two-factor authentication (in short 2FA) can be realized:

    SecSignIDAPI: The class includes all functions for requesting a so-called authentication session

    AuthSession: This class includes all information of a so-called authentication session (in short AuthSession)

    You want to use Composer?

    We prepared an easy to use Composer Bundle for faster integration of SecSign Two-Factor Authentication.

    Composer Bundle

    1. Integration of the API

    Inquire the Secsign ID PHP API and add it to your PHP project or integrate it into the corresponding PHP files.

    2. Request a session

    Request a new session (authentication session) from the ID server. In order to request a session, the user name, respectively the SecSign ID as well as the name of the website, web service or PHP project have to be sent to the server. The name of the website, respectively web service will be shown to the user on the smart phone. An authentication session consists of a session ID, the SecSign ID as well as a so-called ‘Access Pass‘. The class for the session is called ‘AuthSession’. The Access Pass includes a Base64 encoded PNG image. regarding the reason.

    This image must be shown to the user. The same image will be shown to the user on his smart phone. By the comparison of the images the session
    will be accepted on the smart phone.

    If no session can be requested, an exception will be thrown which should be caught. The exception contains an error message

    3. Show access pass to the user and save session parameters

    After a session (authentication session) has been requested from the server the access pass must be shown to the user, e.g on the website. The Access Pass consists of a Base64-coded PNG image. The user compares this image with the images shown on his smart phone. By selecting the correct symbol the user confirms the session.

    For websites this session information must be stored in order to request later the state of the session. On websites this can be done via form fields. The example shows the required information for requesting the state of the session later on.

    • Request ID: The Request ID is the ID of the currently
    • Requested session. Through this ID all further requests,
      e.g. a request for the state of the session are assigned
    • SecSign ID: The user name
    • AuthSession ID: The ID of the requested session
    • Service Name: The name of the PHP project, respectively of the web site
    • Service Address: The IP address, respectively the URL of the PHP project, respectively of the website

    4. Show access pass to the user and save session parameters

    The session which is requested from the server can have different states. As soon as the session is requested from the server, the session has the state „Pending“. When a user wants to confirm the session on the smart phone, the session receives the state „Fetched“. When the user accepts the session by selecting the correct symbol, the state changes to “Authenticated”.

    Other possible states are “Denied”, “Cancelled”, “Expired” and “Suspended’. More detailed information can be found in the comments of the class ‘AuthSession‘.

    It is necessary to react to the user´s acceptance (‘Authenticated’) or denial (‘Denied‘) of the session. This can either be done by an action of the user so that, for example, the form (see point 3) can be sent to the server via buttons or via polling. It can be reacted to the state of the server upon receipt. The session can either be accepted, denied or remain pending. The state can be compared with constants of the class ‘AuthSession‘.

    In case of a failure during the request of the state an exception will be thrown that will be caught.

    5. Reaction to the state of the session

    After the session has been accepted by the user via the smart phone the session shows the state ‘Authenticated‘.

    The user can now be logged into the PHP project or the website, respectively another login can be accepted. If the user denies the session, a corresponding notification can be sent. If the user accepts the session, it must be released with ‘releaseAuthSession‘. If the session is denied or cancelled by the server, a release will not be necessary.

    The explicit release is required as the server does not know how long the accepted session shall be kept until the client, respectively the web site, requests the state.

    If the session is neither accepted nor denied, it remains pending. The Access Pass can then be shown again. If the session is cancelled by the server or has expired, the user should not be logged in.

    6. Cancellation of the session

    If the session is supposed to be cancelled via the client, this can be done via ‘cancelAuthSession‘.

    7. The SecSignApi object

    The communication with the ID server runs via the class ‘SecSignIDApi‘. SecSignIDApi objects do not have to be particularly initiated (see the example under 2).

    The method for requesting a session requires the SecSign ID as parameter, the name of the website or of the PHP project as well as an IP address, respectively the URL of the website. An AuthSession object will be received as return value.

    All other functions of the SecSignIDApi class require a valid AuthSession object as a parameter.

    The functions are:

    • requestAuthSession($secsignid, $servicename, $serviceadress)
    • getAuthSessionState($authSession)
    • cancelAuthSession($authSession)
    • releaseAuthSession($authSession)

    8. The Authsession object and auxiliary functions for the authentication session

    As the single values of the session must be stored there is the auxiliary function ‘createAuthSessionFromArray’ in the class ‘AuthSession‘. A named array, respectively an associative array, is accepted as parameter.

    The fields of the array are as follows:

    • requestid
    • secsignid
    • authsessionid
    • servicename
    • serviceaddress
    • authsessionicondata

    Each of these fields must exist in order to have an AuthSession object created out of it. This object can then request Get functions as normal.

    The Get functions are:

    • getRequestID()
    • getSecSignID()
    • getAuthSessionID()
    • getRequestingServiceName()
    • getRequestingServiceAddress()
    • getIconData()

    All return values are of the type ‘String‘.

    9. Available APIS

    We provide an ever growing list of APIs and plugins to easily integrate the SecSign ID Two-Factor Authentication in any project. An overview is available at Plugin and APIs.
    We do not only offer APIs in different programming languages but also plugins for CMS, Server and VPN environments, oAuth2 and many more. These plugins use our APIs and offer additional functionalities, for example user management, easy and native installation, logging or integration in firewalls or Active Directory.

    The JIRA plugin for example uses the JAVA-API. The PHP-Api and JS-API is used by WordPress, Joomla, Drupal, Typo3 and many more. The ASP.net/C#-API is used for the Windows and Cisco VPN and the C-API is used for protecting Unix SSH services. The Objective-C API is used by our AppleTV and iPhone/iPad apps.

    available_apis

    10. See for yourself

    You can experience the SecSign ID two-factor authentication and the two-factor login by simply integrating the plugin into your website or test environment. Or you can try out the login process on our website without having to register first. You already have a SecSign ID or you want one? Login now and use the portal or use our hassle free registration.

    See for yourself how fast and convenient the login process using challenge-response authentication with 2048-bit key pairs is. There is no need for passwords, and no passwords or other confidential information are ever transmitted. It is easy to integrate and simple to use.

    For more information about the patented SafeKey procedure and it's unique security can be found here.

    If you are missing an API for the programming language you are working with, feel free to contact us and we’ll find a solution with you. If you need help with the integration into an existing system or you can’t find the plugin for your content management system you are working with, don’t hesitate to contact our support team.

    Your own ID-Server

    On premise installations of SecSign ID offer the flexibility to connect with your preferred servers, services, and devices. And you can customize the SecSign ID with your own organization’s branding.

    your_own_id

    Why upgrade to SecSign?

    On-premise or in the cloud

    Choose between our SecSign ID Cloud or operate your own on-premise Two-Factor Authentication server.

    Easy customization

    Operate your own YourBrand ID app - Two-Factor Authentication customized to your needs.

    Ready-to-use SDK

    Integrate SecSign ID Two-Factor Authentication in existing apps with our ready-to-use SDK.

    Easy user management

    Use the Two-Factor Authentication Server to secure your company Active Directory/LDAP. Your own Identity and Access Management System, for example for mandatory updates and additional security features.

    Cover all logins

    Integration in any login environment: web, local, VPN, remote desktop, mobile logins and many more.

    Plugins for all your needs

    No need for complex integration: we have plugins for almost all environments.

    Do NOT follow this link or you will be banned from the site!