README

A package for integrating Swedish BankID in your Laravel applications.

The source code is based on the sample application provided by BankID which is written in Java using Spring.

This package has not been tested on < Laravel 8.

Getting started

Start by installing the package using Composer.

composer require jgroup/laravel-bank-id

Publish config and certificates (test certificates and production ca root certificate) by running:

php artisan vendor:publish --provider="Jgroup\BankID\BankIDServiceProvider"

Production Certificate

Convert your production certificate from PKCS_12 format to two PEM files, ready to be used by running:

openssl pkcs12 -in /path/to/certificate.p12 -passin pass:password_for_certificate_p12 -out /destination/folder/certificate.pem -clcerts -nokeys

openssl pkcs12 -in /path/to/certificate.p12 -passin pass:password_for_certificate_p12 -out /destination/folder/key.pem -nocerts -nodes

Quick auth example

// routes/web.php

<?php

use App\Models\User;
use Illuminate\Http\Response;
use Jgroup\BankID\Facades\BankID;
use Illuminate\Support\Facades\Route;

Route::post('/auth/bankid', function(Request $request) {
    return BankID::auth(
        $request->getClientIp(),
        'Text to display to the user'
    );
});

Route::post('/auth/bankid/collect', function(Request $request) {
    $response = BankID::collect();

    if ($response->getStatus() === 'complete') {
        $personalNumber = $response->getCollectResult()
            ->getCompletionResult()
            ->getPersonalNumber();

        $user = User::where('pnr', $personalNumber)->firstOrFail();

        // clear session transaction when completed
        BankID::setSessionTransaction(null);

        Auth::login($user);
    }

    return $response;
});

Quick sign example

// routes/web.php

<?php

use Illuminate\Http\Response;
use Illuminate\Validation\Rule;
use Jgroup\BankID\Facades\BankID;
use Jgroup\BankID\Rules\SignCompleted;
use Illuminate\Support\Facades\Route;

const SIGN_TEXT = 'Text to sign';

Route::post('/bankid/collect', function(Request $request) {
    return BankID::collect();
});

Route::post('/submit-form/sign', function(Request $request) {
    return BankID::sign(
        $request->getClientIp(),
        SIGN_TEXT
    );
});

Route::post('/submit-form', function(Request $request) {

    $request->validate([
        // transactionId should be sent along with the form data
        'transactionId' => [
            new SignCompleted(SIGN_TEXT)
        ],
        // your validation rules
    ]);

    // logic for handling form submission

    // clear session transaction if submission was processed successfully
    BankID::setSessionTransaction(null);
});

Front-end

We've also developed a web component that works really well with this package and makes it easy to integrate BankID on websites.

Component README

Example usage:

<script type="module" src="https://cdn.jsdelivr.net/gh/janjoo-group/bank-id-components@latest/dist/jgroup-bank-id-components/jgroup-bank-id-components.esm.js"></script>

<!-- this will render a button that will start the configured process, qr generation etc. -->
<jgroup-bank-id
    type="auth"
    auth-url="BANKID_AUTH_START_URL"
    collect-url="BANKID_AUTH_COLLECT_URL"
    cancel-url="BANKID_CANCEL_URL"
    language="sv"
    dark-theme="true"
/>

You can see it in action here: https://app.pejly.com/login

jgroup / laravel-bank-id

Maintainers

Details