1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
%global _empty_manifest_terminate_build 0
Name: python-satosa-oidcop
Version: 1.1.1
Release: 1
Summary: SATOSA Frontend based on idetity python oidcop
License: License :: OSI Approved :: GNU Affero General Public License v3
URL: https://github.com/UniversitaDellaCalabria/satosa-oidcop
Source0: https://mirrors.aliyun.com/pypi/web/packages/8d/8f/cd805dad54051dc69cb9c1afd931cd1323a594e9b97b94e5038dfdafb2bb/satosa_oidcop-1.1.1.tar.gz
BuildArch: noarch
Requires: python3-satosa
Requires: python3-pymongo
Requires: python3-oidcop
%description
[](https://pepy.tech/project/satosa-oidcop)
[](https://pepy.tech/project/satosa-oidcop)
SATOSA Frontend based on [identity python oidcop](https://github.com/IdentityPython/oidc-op).
## Features
Endpoints:
* [x] provider discovery
* [x] jwks uri
* [x] authorization
* [x] token
* [x] userinfo
* [x] registration
* [x] registration_read endpoint
* [x] introspection endpoint
* [ ] token exchange
## Requirements
- satosa
- mongodb, see [Satosa-Saml2Spid mongo example](https://github.com/italia/Satosa-Saml2Spid/tree/master/mongo).
## Setup
````
pip install satosa_oidcop
````
## Configuration
Anyone can migrate its oidcop configuration, from flask_op or django-oidc-op or whatever, in SATOSA and without any particular efforts. Looking at the [example configuration](example/oidcop_frontend.yaml) we see that `config.op.server_info` have a standard SATOSA configuration with the only addition of the following customizations, needed in SATOSA for interoperational needs. These are:
- autentication
````
authentication:
user:
acr: urn:oasis:names:tc:SAML:2.0:ac:classes:InternetProtocolPassword
class: satosa.frontends.oidcop.user_authn.SatosaAuthnMethod
````
- userinfo
````
userinfo:
class: satosa.frontends.oidcop.user_info.SatosaOidcUserInfo
````
**authentication** inherits `oidcop.user_authn.user.UserAuthnMethod` and overloads two methods involved in user authentication and verification. These tasks are handled by SATOSA in its authentication backends.
**userinfo** inherits `oidcop.user_info.UserInfo` and proposes a way to store the claims of the users when they comes from the backend. The claims are stored in the session database (actually mongodb) and then they will be fetched during userinfo endpoint (and also token endpoint, for having them optionally in id_token claims).
#### SSO and cookies
oidcop SSO and cookies were not have been implemented because SATOSA doesn't support logout, because of this they are quite useless at this moment.
#### Client and Session Storage
MongoDB is the storage, [here](https://github.com/italia/Satosa-Saml2Spid/tree/oidcop/mongo) some brief descriptions for a demo setup. The interface to SATOSA oidcop storage is `satosa.frontends.oidcop.storage.base.SatosaOidcStorage` and it has three methods:
- **get_client_by_id**(self, client_id:str, expired:bool = True)
- **store_session_to_db**(self, session_manager, **kwargs)
- **load_session_from_db**(self, req_args, http_headers, session_manager, **kwargs)
`satosa.frontends.oidcop.storage.mongo.Mongodb` overloads them to have I/O operations on mongodb.
##### Subject type #####
The client configuration can also include the `subject_type` key, with permitted values being `public` and `pairwise`. If absent, the default is to choose `public`. This has been driven by backwards compatibility with existing behaviour: oidcop (`session_manager.create_session`) defaults to `public`.
For user privacy, we strongly recommend selecting `pairwise` for new deployments, unless `public` is absolutely needed (for linking users across related but distinct services).
## Demo
[Satosa-Saml2Spid](https://github.com/italia/Satosa-Saml2Spid/) is a custom Satosa configuration to deal with many SAML2 and OIDC Relying parties and many eduGain and SPID Identity Provider.
## Contributions
Feel free to open issues and pull requests, we build communities!
## Developer notes
#### Storage design
At this time the storage logic is based on oidcop session_manager load/dump/flush methods.
Each time a request is handled by an endpoint the oidcop session manager loads the definition from the storage, **only which one are strictly related to the request will be loaded** in the in memory storage of oidcop.
#### Roadmap
* [x] unit tests
* [x] pytest mongo mock
* [x] test response_type = "code id_token token" (https://github.com/IdentityPython/SATOSA/pull/378/commits/a61dc99503bcb9d4982b77a6ddcf0c41b6732915)
* [x] auto prune expired sessions with mongodb index (https://github.com/IdentityPython/SATOSA/pull/378/commits/137993f77bfb05b44f25ba6df3784e8fb86a31ce, [mongo index](https://github.com/italia/Satosa-Saml2Spid/tree/oidcop/mongo#create-expired-session-deletion))
* [x] token refresh (https://github.com/IdentityPython/SATOSA/pull/378/commits/59c0a53fa73e70551d76c5355c051a7389ab99fd)
* [ ] DPoP support
#### Tests
Before you run the tests mind that you've to start a local mongod instance, e.g. with:
```
docker run --rm -e ALLOW_EMPTY_PASSWORD=yes -e MONGODB_ENABLE_JOURNAL=false -p 27017:27017 --name mongodb bitnami/mongodb:latest
```
Then run the tests:
````
pip install pytest pytest-cov
pytest --cov=satosa_oidcop -v --cov-report term --cov-fail-under=95 tests/
````
## Authors
- Giuseppe De Marco <at> Università della Calabria
## Credits
- Roland Hedberg
- Andrea Ranaldi <at> ISPRA Ambiente
- Identity Python Community
%package -n python3-satosa-oidcop
Summary: SATOSA Frontend based on idetity python oidcop
Provides: python-satosa-oidcop
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-satosa-oidcop
[](https://pepy.tech/project/satosa-oidcop)
[](https://pepy.tech/project/satosa-oidcop)
SATOSA Frontend based on [identity python oidcop](https://github.com/IdentityPython/oidc-op).
## Features
Endpoints:
* [x] provider discovery
* [x] jwks uri
* [x] authorization
* [x] token
* [x] userinfo
* [x] registration
* [x] registration_read endpoint
* [x] introspection endpoint
* [ ] token exchange
## Requirements
- satosa
- mongodb, see [Satosa-Saml2Spid mongo example](https://github.com/italia/Satosa-Saml2Spid/tree/master/mongo).
## Setup
````
pip install satosa_oidcop
````
## Configuration
Anyone can migrate its oidcop configuration, from flask_op or django-oidc-op or whatever, in SATOSA and without any particular efforts. Looking at the [example configuration](example/oidcop_frontend.yaml) we see that `config.op.server_info` have a standard SATOSA configuration with the only addition of the following customizations, needed in SATOSA for interoperational needs. These are:
- autentication
````
authentication:
user:
acr: urn:oasis:names:tc:SAML:2.0:ac:classes:InternetProtocolPassword
class: satosa.frontends.oidcop.user_authn.SatosaAuthnMethod
````
- userinfo
````
userinfo:
class: satosa.frontends.oidcop.user_info.SatosaOidcUserInfo
````
**authentication** inherits `oidcop.user_authn.user.UserAuthnMethod` and overloads two methods involved in user authentication and verification. These tasks are handled by SATOSA in its authentication backends.
**userinfo** inherits `oidcop.user_info.UserInfo` and proposes a way to store the claims of the users when they comes from the backend. The claims are stored in the session database (actually mongodb) and then they will be fetched during userinfo endpoint (and also token endpoint, for having them optionally in id_token claims).
#### SSO and cookies
oidcop SSO and cookies were not have been implemented because SATOSA doesn't support logout, because of this they are quite useless at this moment.
#### Client and Session Storage
MongoDB is the storage, [here](https://github.com/italia/Satosa-Saml2Spid/tree/oidcop/mongo) some brief descriptions for a demo setup. The interface to SATOSA oidcop storage is `satosa.frontends.oidcop.storage.base.SatosaOidcStorage` and it has three methods:
- **get_client_by_id**(self, client_id:str, expired:bool = True)
- **store_session_to_db**(self, session_manager, **kwargs)
- **load_session_from_db**(self, req_args, http_headers, session_manager, **kwargs)
`satosa.frontends.oidcop.storage.mongo.Mongodb` overloads them to have I/O operations on mongodb.
##### Subject type #####
The client configuration can also include the `subject_type` key, with permitted values being `public` and `pairwise`. If absent, the default is to choose `public`. This has been driven by backwards compatibility with existing behaviour: oidcop (`session_manager.create_session`) defaults to `public`.
For user privacy, we strongly recommend selecting `pairwise` for new deployments, unless `public` is absolutely needed (for linking users across related but distinct services).
## Demo
[Satosa-Saml2Spid](https://github.com/italia/Satosa-Saml2Spid/) is a custom Satosa configuration to deal with many SAML2 and OIDC Relying parties and many eduGain and SPID Identity Provider.
## Contributions
Feel free to open issues and pull requests, we build communities!
## Developer notes
#### Storage design
At this time the storage logic is based on oidcop session_manager load/dump/flush methods.
Each time a request is handled by an endpoint the oidcop session manager loads the definition from the storage, **only which one are strictly related to the request will be loaded** in the in memory storage of oidcop.
#### Roadmap
* [x] unit tests
* [x] pytest mongo mock
* [x] test response_type = "code id_token token" (https://github.com/IdentityPython/SATOSA/pull/378/commits/a61dc99503bcb9d4982b77a6ddcf0c41b6732915)
* [x] auto prune expired sessions with mongodb index (https://github.com/IdentityPython/SATOSA/pull/378/commits/137993f77bfb05b44f25ba6df3784e8fb86a31ce, [mongo index](https://github.com/italia/Satosa-Saml2Spid/tree/oidcop/mongo#create-expired-session-deletion))
* [x] token refresh (https://github.com/IdentityPython/SATOSA/pull/378/commits/59c0a53fa73e70551d76c5355c051a7389ab99fd)
* [ ] DPoP support
#### Tests
Before you run the tests mind that you've to start a local mongod instance, e.g. with:
```
docker run --rm -e ALLOW_EMPTY_PASSWORD=yes -e MONGODB_ENABLE_JOURNAL=false -p 27017:27017 --name mongodb bitnami/mongodb:latest
```
Then run the tests:
````
pip install pytest pytest-cov
pytest --cov=satosa_oidcop -v --cov-report term --cov-fail-under=95 tests/
````
## Authors
- Giuseppe De Marco <at> Università della Calabria
## Credits
- Roland Hedberg
- Andrea Ranaldi <at> ISPRA Ambiente
- Identity Python Community
%package help
Summary: Development documents and examples for satosa-oidcop
Provides: python3-satosa-oidcop-doc
%description help
[](https://pepy.tech/project/satosa-oidcop)
[](https://pepy.tech/project/satosa-oidcop)
SATOSA Frontend based on [identity python oidcop](https://github.com/IdentityPython/oidc-op).
## Features
Endpoints:
* [x] provider discovery
* [x] jwks uri
* [x] authorization
* [x] token
* [x] userinfo
* [x] registration
* [x] registration_read endpoint
* [x] introspection endpoint
* [ ] token exchange
## Requirements
- satosa
- mongodb, see [Satosa-Saml2Spid mongo example](https://github.com/italia/Satosa-Saml2Spid/tree/master/mongo).
## Setup
````
pip install satosa_oidcop
````
## Configuration
Anyone can migrate its oidcop configuration, from flask_op or django-oidc-op or whatever, in SATOSA and without any particular efforts. Looking at the [example configuration](example/oidcop_frontend.yaml) we see that `config.op.server_info` have a standard SATOSA configuration with the only addition of the following customizations, needed in SATOSA for interoperational needs. These are:
- autentication
````
authentication:
user:
acr: urn:oasis:names:tc:SAML:2.0:ac:classes:InternetProtocolPassword
class: satosa.frontends.oidcop.user_authn.SatosaAuthnMethod
````
- userinfo
````
userinfo:
class: satosa.frontends.oidcop.user_info.SatosaOidcUserInfo
````
**authentication** inherits `oidcop.user_authn.user.UserAuthnMethod` and overloads two methods involved in user authentication and verification. These tasks are handled by SATOSA in its authentication backends.
**userinfo** inherits `oidcop.user_info.UserInfo` and proposes a way to store the claims of the users when they comes from the backend. The claims are stored in the session database (actually mongodb) and then they will be fetched during userinfo endpoint (and also token endpoint, for having them optionally in id_token claims).
#### SSO and cookies
oidcop SSO and cookies were not have been implemented because SATOSA doesn't support logout, because of this they are quite useless at this moment.
#### Client and Session Storage
MongoDB is the storage, [here](https://github.com/italia/Satosa-Saml2Spid/tree/oidcop/mongo) some brief descriptions for a demo setup. The interface to SATOSA oidcop storage is `satosa.frontends.oidcop.storage.base.SatosaOidcStorage` and it has three methods:
- **get_client_by_id**(self, client_id:str, expired:bool = True)
- **store_session_to_db**(self, session_manager, **kwargs)
- **load_session_from_db**(self, req_args, http_headers, session_manager, **kwargs)
`satosa.frontends.oidcop.storage.mongo.Mongodb` overloads them to have I/O operations on mongodb.
##### Subject type #####
The client configuration can also include the `subject_type` key, with permitted values being `public` and `pairwise`. If absent, the default is to choose `public`. This has been driven by backwards compatibility with existing behaviour: oidcop (`session_manager.create_session`) defaults to `public`.
For user privacy, we strongly recommend selecting `pairwise` for new deployments, unless `public` is absolutely needed (for linking users across related but distinct services).
## Demo
[Satosa-Saml2Spid](https://github.com/italia/Satosa-Saml2Spid/) is a custom Satosa configuration to deal with many SAML2 and OIDC Relying parties and many eduGain and SPID Identity Provider.
## Contributions
Feel free to open issues and pull requests, we build communities!
## Developer notes
#### Storage design
At this time the storage logic is based on oidcop session_manager load/dump/flush methods.
Each time a request is handled by an endpoint the oidcop session manager loads the definition from the storage, **only which one are strictly related to the request will be loaded** in the in memory storage of oidcop.
#### Roadmap
* [x] unit tests
* [x] pytest mongo mock
* [x] test response_type = "code id_token token" (https://github.com/IdentityPython/SATOSA/pull/378/commits/a61dc99503bcb9d4982b77a6ddcf0c41b6732915)
* [x] auto prune expired sessions with mongodb index (https://github.com/IdentityPython/SATOSA/pull/378/commits/137993f77bfb05b44f25ba6df3784e8fb86a31ce, [mongo index](https://github.com/italia/Satosa-Saml2Spid/tree/oidcop/mongo#create-expired-session-deletion))
* [x] token refresh (https://github.com/IdentityPython/SATOSA/pull/378/commits/59c0a53fa73e70551d76c5355c051a7389ab99fd)
* [ ] DPoP support
#### Tests
Before you run the tests mind that you've to start a local mongod instance, e.g. with:
```
docker run --rm -e ALLOW_EMPTY_PASSWORD=yes -e MONGODB_ENABLE_JOURNAL=false -p 27017:27017 --name mongodb bitnami/mongodb:latest
```
Then run the tests:
````
pip install pytest pytest-cov
pytest --cov=satosa_oidcop -v --cov-report term --cov-fail-under=95 tests/
````
## Authors
- Giuseppe De Marco <at> Università della Calabria
## Credits
- Roland Hedberg
- Andrea Ranaldi <at> ISPRA Ambiente
- Identity Python Community
%prep
%autosetup -n satosa_oidcop-1.1.1
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-satosa-oidcop -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 1.1.1-1
- Package Spec generated
|
