Skip to main content

ESIA integration library

Project description

ESIA-Connector: integration library for esia.gosuslugi.ru portal
================================================================

Abstract
--------

ESIA-Connector is an integration library for authenticating users using Russian Federation
official authentication services, provided by ESIA (aka "gosuslugi": http://esia.gosuslugi.ru),
written in python 3.


About
-----
ESIA-Connector supports authentication using OpenId Connect protocol and includes
simple built-in REST client for fetching user personal information.


Structure
---------
ESIA-Connector library contains next classes:

- ESIAAuth - class for generating url for user authentication at esia portal and handling redirected
redirected authentication request (handler exchanges request data for ESIA access token).

- EsiaInformationConnectorBase - base class for using ESIA REST-based information services.

- EsiaPersonInformationConnector - class for fetching user personal information using obtained token


Installation
------------

To install ESIA-connector, simply:

.. code-block:: bash

$ pip install git+https://github.com/saprun/esia-connector.git@master


Documentation
-------------

For more information see examples/flask_app.py - full featured integration example built on top flask
web framework. To run example flask app without library install make next steps:

1) Generate you key and certificate and replace with em files in examples/res/. Create your system at ESIA and upload you certificate to ESIA server. Modify examples/flask_app.py - specify your system id as esia_client_id.

2) Run in shell these commands:

.. code-block:: bash

$ git clone git@github.com:saprun/esia-connector.git
$ cd esia_connector
$ pip install -r requirements-dev.txt
$ cd esia_connector/examples
$ python flask_app.py

Server will be listening on http://localhost:5000. Browse to that address from your web browser, click
link on the page and you'll be redirected to ESIA portal. Enter valid user credentials and you'll be
redirected back to your local server. If everything is ok, you'll see JSON containing your name.


Contribute
----------

#. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
#. Fork this repository on GitHub to start making your changes. Please note, that for development you have to install requirements manually using: pip install -r requirements-dev.txt command in cloned repository directory.

#. Write a test which shows that the bug was fixed or that the feature works as expected.
#. Send a pull request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for esia-connector, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size esia-connector-0.1.tar.gz (4.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page