https://github.com/otto-aa/solid-client-credentials-py
Solid authentication with client credentials in python
https://github.com/otto-aa/solid-client-credentials-py
authentication client-credentials dpop solid
Last synced: 9 months ago
JSON representation
Solid authentication with client credentials in python
- Host: GitHub
- URL: https://github.com/otto-aa/solid-client-credentials-py
- Owner: Otto-AA
- License: mit
- Created: 2023-02-18T12:51:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T10:16:34.000Z (about 1 year ago)
- Last Synced: 2025-06-30T22:03:19.001Z (11 months ago)
- Topics: authentication, client-credentials, dpop, solid
- Language: Python
- Homepage: https://solid-client-credentials.readthedocs.io/
- Size: 441 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Solid Client Credentials
Solid authentication with client credentials.
[](https://github.com/Otto-AA/solid-client-credentials-py/actions)
[](https://codecov.io/gh/Otto-AA/solid-client-credentials-py)
[](https://pypi.org/project/SolidClientCredentials)
[](https://pypi.org/project/SolidClientCredentials)
[](https://pypistats.org/packages/SolidClientCredentials)
## Setup
### Requirements
* Python 3.10+ (likely works with lower versions, but not tested)
### Installation
```bash
$ pip install SolidClientCredentials
```
## Use Case
!!! note
Client credentials are not standardized, thus you can't run your application through any Solid pod. However, users from any provider can give your app access through standardized mechanisms (eg ACL).
You can use client credentials to create a server-side application that authenticates as a webId on ESS or CSS. After obtaining the client credentials for a webId, you can use them to make authenticated requests on behalf of this account. You will be able to access all resources this webId has access to. If you want to access data of other users, they must grant access rights to your apps webId.
See also: [https://docs.inrupt.com/developer-tools/javascript/client-libraries/tutorial/authenticate-nodejs-script/](https://docs.inrupt.com/developer-tools/javascript/client-libraries/tutorial/authenticate-nodejs-script/)
## Usage
To use this package you first need valid client credentials (see [below](#obtaining-client-credentials)). Given the client credentials you can use it as follows:
```python
from solid_client_credentials import SolidClientCredentialsAuth, DpopTokenProvider
import requests # or httpx
client_id = 'your-id'
client_secret = 'your-secret'
# The server that provides your account (where you login)
issuer_url = 'https://login.inrupt.com'
# create a token provider
token_provider = DpopTokenProvider(
issuer_url=issuer_url,
client_id=client_id,
client_secret=client_secret
)
# use the tokens with the requests (or httpx) library
auth = SolidClientCredentialsAuth(token_provider)
res = requests.get('https://example.org/private/stuff', auth=auth)
print(res.text)
```
## Obtaining client credentials
This is currently only possible with ESS and CSS.
### ESS
ESS allows to manually obtain client credentials: [https://login.inrupt.com/registration.html](https://login.inrupt.com/registration.html)
### CSS
CSS allows to automatically obtain client credentials: [https://communitysolidserver.github.io/CommunitySolidServer/5.x/usage/client-credentials/](https://communitysolidserver.github.io/CommunitySolidServer/5.x/usage/client-credentials/)
You can also look at `css_utils.py` to see how this maps to python.