README

With the DocCheck Login you are able to very simply establish a protected area on your site, which is only accessible to (medical) professionals The DocCheck password protection is an identification service for medical sites which is compliant with the German law for pharmaceutical commercial information HWG (Heilmittelwerbegesetz)

Installation

You can install the package via composer:

composer require rs/auth-doccheck

Configuration

Before using DocCheck, you will need to add credentials for the provider.

DOCCHECK_LOGIN_ID=123
DOCCHECK_SECRET=my-secret

The doc check secret is optional and provides greater security.When acquiring the Economy or Business Licence you obtain a secret key from DocCheck.

If you need to overwrite the config, you can publish them using the vendor:publish Artisan command:

php artisan vendor:publish --tag=doccheck

Authentication

DocCheck provides an iframe for allowing users to login using their service. This package allows for generation of the iframe url.

use RedSnapper\DocCheck\DocCheckProvider;

Route::get('/login', function (DocCheckProvider $provider) {
    $provider->language("de")->template("login_s");
    return view('login',['url'=>$provider->iframeUrl()])
});

The iframe can be further configured to use which language and which template that is appropriate. Available languages are de, com, fr, it, es, nl, frbe. Available templates are "login_s", "login_m", "login_l", "login_xl".

To authenticate users using the Doccheck, you will need a route for receiving the callback from the provider after authentication. The example controller below demonstrates the implementation:

It is also possible to generate the iframe markup directly.

use RedSnapper\DocCheck\DocCheckProvider;

Route::get('/login', function (DocCheckProvider $provider) {
    return $provider->iframe();
});

use RedSnapper\DocCheck\DocCheckProvider;

Route::get('/auth/callback', function (DocCheckProvider $provider) {
    $user = $provider->user();
});

The user method will read the incoming request and retrieve the user's information from the provider after they are authenticated.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email param@redsnapper.net instead of using the issue tracker.

rs / auth-doccheck

Maintainers

Details