{ "info": { "author": "Hanne Moa", "author_email": "hanne.moa@uninett.no", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.11", "Framework :: Flask", "Framework :: Pyramid", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3 :: Only", "Topic :: Internet :: WWW/HTTP", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Utilities" ], "description": "social-auth-backend-b2access\n============================\n\nB2ACCESS_ is an easy-to-use and secure Authentication and\nAuthorization platform developed by EUDAT. B2ACCESS offers\nauthentication of users to applications using OAuth 2.0, OpenID\nConnect and SAML.\n\n``social-auth-backend-b2access`` is an OAuth2 client for B2ACCESS\nthat depends on social-auth-core_.\n\nThis is a Python 3 based project. No attempts\nhave been made to make it backwards compatible with Python 2.\n\n\nInstallation\n------------\n\nInstall with ``pip install social-auth-backend-b2access`` or by\ndownloading the source and running ``setup.py``.\n\n\nUsage\n-----\n\nSet up a service at B2ACCESS\n.............................\n\nThere needs to exist an entry for your site/app/service at\nB2ACCESS. Go to `B2ACCESS`_ but do not log in. Click on ``Register\na new account``. In the popup, click on ``OAuth 2.0 Client\nRegistration Form``. This will bring up a new popup, \"Registration\nForm\".\n\nThe ``username`` and ``password`` will be used later to change\ninformation about the app, but will also be used as the OAuth2\n``KEY`` and ``SECRET``. ``mail`` is the correct contact email\naddress for the person responsible for the service. ``OAuth client\nreturn URL`` is what B2ACCESS calls the endpoints to the service.\n``social-auth`` calls these ``redirect uris``, and there can be\nmore than one. ``Admin`` is the name of the person responsible for\nthe service. The ``usage``-field must be filled with at least\n30 characters.\n\nThe redirect uri is of the form ``:////``,\nwhere ```` is one of ``http`` or ``https``, ````\nis the domain name of your site and an optional path, and the\n```` is backend-dependent. See the examples under\n**Backends**.\n\nSet up your site\n................\n\nYou'll need to set the client id (username) and client secret\n(password) you chose for B2ACCESS in the settings of your\napp/site.\n\nBoth the name of the settings and the redirect uris depend on the\nbackends used. Add at least one of the backends below.\n\nSee `social's documentation`_ for more.\n\nDjango\n......\n\nIn your ``settings.py``:\n\n* Add ``'social_django'`` to ``INSTALLED_APPS``.\n* Add one or more of the backend names below to the start of\n ``AUTHENTICATION_BACKENDS``. If you're also using user-models\n \u00e0 la Django, ``'django.contrib.auth.backends.ModelBackend'``\n must be in the same list, following the backends.\n* Set ``SOCIAL_AUTH_B2ACCESS_SSL_PROTOCOL`` to ``True`` to force\n use of SSL.\n* ``SOCIAL_AUTH_LOGIN_REDIRECT_URL``,\n ``SOCIAL_AUTH_NEW_USER_REDIRECT_URL`` and\n ``SOCIAL_AUTH_REDIRECT_IS_HTTPS`` will have to be set depending\n on the needs of your site.\n* If you use the Django admin, you might want to set\n ``SOCIAL_AUTH_ADMIN_USER_SEARCH_FIELDS``, for instance to\n ``['username', 'email']``.\n\nIn your site's ``urls.py``, include:\n\n``url(PREFIX, include('social_django.urls', namespace='social')),``\n\n... where PREFIX is a string to start off the urls with. Empty\nstring, ``''``, is fine.\n\n\nGenerating usernames\n--------------------\n\nBy default, the username that is returned is B2ACCESS'\n\"name\"-field, which holds a full name of a person. Also, the name\nis cleaned via a regular expression, see the table of results below:\n\n+------------+---------+\n| Before | After |\n+------------+---------+\n| John Doe | JohnDoe |\n+------------+---------+\n| Sch\u00fcltz | Schltz |\n+------------+---------+\n\nIf you don't want the username to be cleaned, set\n``SOCIAL_AUTH_CLEAN_USERNAMES`` to ``False`` in settings.\n\nIf you want to make the username very url-friendly, set\n``SOCIAL_AUTH_SLUGIFY_USERNAMES`` to ``True``. \"John Doe\" will\nthen be converted to \"john-doe\". This will also strip away\nnon-ASCII letters.\n\nIf you want to use email-addresses for the username, set\n``SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL`` to ``True`` in settings.\n\nIf there already is a user with that username registered, the\nusername will have a random alpahnumeric string appended in order\nto make it unique.\n\nYou might want to let users change this generated username. The\nbackend only cares that a username exists and is unique and won't\nchange the username back.\n\n\nBackends\n--------\n\nb2access.B2ACCESSOAuth2\n.......................\n\nThis is for services in production.\n\nRegister service at\n `B2ACCESS`_\n\nBackend name\n ``b2access.B2ACCESSOAuth2``\n\nSettings\n Client id: ``SOCIAL_AUTH_B2ACCESS_KEY``\n\n Client secret: ``SOCIAL_AUTH_B2ACCESS_SECRET``\n\nScopes needed\n ``email`` and ``profile``\n\nRedirect-uri ends with\n /complete/b2access/\n\nExample redirect uri:\n http://127.0.0.1/complete/b2access/\n\nb2access.B2ACCESSIntegrationOAuth2\n..................................\n\nThis is for services not yet fully in production.\n\nRegister service at\n https://b2access-integration.fz-juelich.de/home/\n\nBackend name\n ``b2access.B2ACCESSIntegrationOAuth2``\n\nSettings\n Client id: ``SOCIAL_AUTH_B2ACCESS_TEST_KEY``\n\n Client secret: ``SOCIAL_AUTH_B2ACCESS_TEST_SECRET``\n\nScopes needed\n ``email`` and ``profile``\n\nRedirect-uri ends with\n /complete/b2access-test/\n\nExample redirect uri:\n http://127.0.0.1/complete/b2access-test/\n\n.. _B2ACCESS: https://b2access.eudat.eu/\n.. _social-auth-core: https://python-social-auth.readthedocs.io/en/latest/\n.. _social's documentation: https://python-social-auth.readthedocs.io/en/latest/\n.. _python-social-auth: https://pypi.python.org/pypi/social-auth\n\n\n:Version: 1.0.0\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/UNINETT/python-b2access-auth", "keywords": "django,oauth2", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "social-auth-backend-b2access", "package_url": "https://pypi.org/project/social-auth-backend-b2access/", "platform": "any", "project_url": "https://pypi.org/project/social-auth-backend-b2access/", "project_urls": { "Homepage": "https://github.com/UNINETT/python-b2access-auth" }, "release_url": "https://pypi.org/project/social-auth-backend-b2access/1.0.0/", "requires_dist": [ "social-auth-core" ], "requires_python": "", "summary": "A plugin for social-auth to authenticate with b2access", "version": "1.0.0" }, "last_serial": 3412694, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "cbc90c1c5aa35ebd98ae23813b8d96b8", "sha256": "1a8c56c8b7fe9743317ccfe2fae7efb095bcdcc78aa301c39e6a0cb6b4a4ddab" }, "downloads": -1, "filename": "social_auth_backend_b2access-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "cbc90c1c5aa35ebd98ae23813b8d96b8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7776, "upload_time": "2017-12-11T12:16:29", "url": "https://files.pythonhosted.org/packages/e4/79/2e8d4dbcdf5ec8ede7d54aac989c3247e0146135d3f3786f47a6ce58b53c/social_auth_backend_b2access-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6798218095dac931aee6943970269073", "sha256": "f1b0eac475ea7793b3852cc92aa76981ce8be39ff1f6a23e11b4229f95c2134b" }, "downloads": -1, "filename": "social-auth-backend-b2access-0.1.0.tar.gz", "has_sig": false, "md5_digest": "6798218095dac931aee6943970269073", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5478, "upload_time": "2017-12-11T12:16:31", "url": "https://files.pythonhosted.org/packages/e2/42/ee78521adbc280347b170b447147a1b2b177c34b670061922522696d3185/social-auth-backend-b2access-0.1.0.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "1fa02265904877c30d234febbe81974d", "sha256": "93a62adbc520866b7d1447b1ff26da52a6f9e69ad02bed4ced666dfd421f6539" }, "downloads": -1, "filename": "social_auth_backend_b2access-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1fa02265904877c30d234febbe81974d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7778, "upload_time": "2017-12-13T09:35:05", "url": "https://files.pythonhosted.org/packages/5d/ec/770893fd1ec95de7cde33f1edd385b42ac1d544b7243db6d1137f03ee37a/social_auth_backend_b2access-1.0.0-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1fa02265904877c30d234febbe81974d", "sha256": "93a62adbc520866b7d1447b1ff26da52a6f9e69ad02bed4ced666dfd421f6539" }, "downloads": -1, "filename": "social_auth_backend_b2access-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1fa02265904877c30d234febbe81974d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7778, "upload_time": "2017-12-13T09:35:05", "url": "https://files.pythonhosted.org/packages/5d/ec/770893fd1ec95de7cde33f1edd385b42ac1d544b7243db6d1137f03ee37a/social_auth_backend_b2access-1.0.0-py2.py3-none-any.whl" } ] }