summaryrefslogtreecommitdiff
path: root/python-arpoc.spec
blob: 7f9d52f237355308152e1d09ff30c6ccc12bb061 (plain)
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
322
323
324
325
326
327
328
%global _empty_manifest_terminate_build 0
Name:		python-ARPOC
Version:	0.3.1
Release:	1
Summary:	An Authentication Reverse Proxy using OpenID Connect
License:	MIT
URL:		https://pypi.org/project/ARPOC/
Source0:	https://mirrors.aliyun.com/pypi/web/packages/51/5b/3a6f6eecbb33fdd4ee98524335b4d550716dab2e7cba562dec2dee4f7b22/ARPOC-0.3.1.tar.gz
BuildArch:	noarch

Requires:	python3-cherrypy
Requires:	python3-jinja2
Requires:	python3-lark-parser
Requires:	python3-oic
Requires:	python3-pyjwkest
Requires:	python3-pyyaml
Requires:	python3-routes

%description
# ARPOC

A simple reverse proxy that adds OpenID Connect Authentication and lets you
write access rules for services you want to protect.

## Fast tutorial

You will need:

* A domain name `<domain>`
* A tls keypair (`<fullchain>`, `<privkey>`)
* A server with python (3.7 or newer) `<python3>`

### Install

* Download the repository and run `<python3> setup.py install`, or install via pip: `pip install arpoc`
* If successful you should now have the `arpoc` command.
* Make yourself familiar with the basic interface with `arpoc --help`.
* Create a configuration file `arpoc --print-sample-config`
* Save the configuration file (preferable under /etc/arpoc/config.yml)
* Create a default access control hierarchy using `arpoc --print-sample-config`
* Save the access control hierarchy in a json file (defaultdir: /etc/arpoc/acl/)

### Edit the sample configuration

Fill in the right values for `<keyfile>`, `<certfile>`, `<domainname>`, `<redirect>`
urls (path the openid connect providers will redirect the user to, with a leading
slash) and the contacts field (at least on valid mail adress).


### Add an openid connect provider

You need the configuration url (should end with .well-known/openid/configuration, cut this part of, it is added automatically).
You also need either:

* A configuration token
* A registration url and a registration token
* Client ID and Client Secret


#### Configuration URL and Token:

Choose a key which arpoc uses internally for the provider.

Add both parameters to the config.yml under
`openid_providers -> <key> -> configuration_url`
`openid_providers -> <key> -> configuration_token`

#### Registration URL and registration token:

If you already registered your client and have a registration token add 
the configuration url, the registration url and the registration token
under to the config.yml file under
`openid_providers -> <key>` using the `configuration_url`, `registration_url`
and `registration_token`.

#### Client ID and Client Secret

Add the configuration url to the config.yml.
Call `arpoc --add-provider <key> --client-id <client_id> --client-secret <client-secret>`


### Add a service you want to protect.

You need the origin url, the proxy url and the key of an access control policy
set (the key of an ac entity in the json file with type policy set).

Choose a key which arpoc will internally use for the service.
Add the origin url and the proxy url (the path under which the service will be
available with a leading slash) using the `origin_URL` and `proxy_url` keys
under `services -> <service key> -> ` to the config.yml

*Now you should be able to access the service.*


## Dependencies

* [pyjwkest](https://github.com/IdentityPython/pyjwkest/) -- a python library for web tokens
* [lark-parser](https://github.com/lark-parser/lark) -- a parser for the access control language
* [pyoidc](https://github.com/OpenIDC/pyoidc) -- a python library for Open ID Connect
* ...




%package -n python3-ARPOC
Summary:	An Authentication Reverse Proxy using OpenID Connect
Provides:	python-ARPOC
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-ARPOC
# ARPOC

A simple reverse proxy that adds OpenID Connect Authentication and lets you
write access rules for services you want to protect.

## Fast tutorial

You will need:

* A domain name `<domain>`
* A tls keypair (`<fullchain>`, `<privkey>`)
* A server with python (3.7 or newer) `<python3>`

### Install

* Download the repository and run `<python3> setup.py install`, or install via pip: `pip install arpoc`
* If successful you should now have the `arpoc` command.
* Make yourself familiar with the basic interface with `arpoc --help`.
* Create a configuration file `arpoc --print-sample-config`
* Save the configuration file (preferable under /etc/arpoc/config.yml)
* Create a default access control hierarchy using `arpoc --print-sample-config`
* Save the access control hierarchy in a json file (defaultdir: /etc/arpoc/acl/)

### Edit the sample configuration

Fill in the right values for `<keyfile>`, `<certfile>`, `<domainname>`, `<redirect>`
urls (path the openid connect providers will redirect the user to, with a leading
slash) and the contacts field (at least on valid mail adress).


### Add an openid connect provider

You need the configuration url (should end with .well-known/openid/configuration, cut this part of, it is added automatically).
You also need either:

* A configuration token
* A registration url and a registration token
* Client ID and Client Secret


#### Configuration URL and Token:

Choose a key which arpoc uses internally for the provider.

Add both parameters to the config.yml under
`openid_providers -> <key> -> configuration_url`
`openid_providers -> <key> -> configuration_token`

#### Registration URL and registration token:

If you already registered your client and have a registration token add 
the configuration url, the registration url and the registration token
under to the config.yml file under
`openid_providers -> <key>` using the `configuration_url`, `registration_url`
and `registration_token`.

#### Client ID and Client Secret

Add the configuration url to the config.yml.
Call `arpoc --add-provider <key> --client-id <client_id> --client-secret <client-secret>`


### Add a service you want to protect.

You need the origin url, the proxy url and the key of an access control policy
set (the key of an ac entity in the json file with type policy set).

Choose a key which arpoc will internally use for the service.
Add the origin url and the proxy url (the path under which the service will be
available with a leading slash) using the `origin_URL` and `proxy_url` keys
under `services -> <service key> -> ` to the config.yml

*Now you should be able to access the service.*


## Dependencies

* [pyjwkest](https://github.com/IdentityPython/pyjwkest/) -- a python library for web tokens
* [lark-parser](https://github.com/lark-parser/lark) -- a parser for the access control language
* [pyoidc](https://github.com/OpenIDC/pyoidc) -- a python library for Open ID Connect
* ...




%package help
Summary:	Development documents and examples for ARPOC
Provides:	python3-ARPOC-doc
%description help
# ARPOC

A simple reverse proxy that adds OpenID Connect Authentication and lets you
write access rules for services you want to protect.

## Fast tutorial

You will need:

* A domain name `<domain>`
* A tls keypair (`<fullchain>`, `<privkey>`)
* A server with python (3.7 or newer) `<python3>`

### Install

* Download the repository and run `<python3> setup.py install`, or install via pip: `pip install arpoc`
* If successful you should now have the `arpoc` command.
* Make yourself familiar with the basic interface with `arpoc --help`.
* Create a configuration file `arpoc --print-sample-config`
* Save the configuration file (preferable under /etc/arpoc/config.yml)
* Create a default access control hierarchy using `arpoc --print-sample-config`
* Save the access control hierarchy in a json file (defaultdir: /etc/arpoc/acl/)

### Edit the sample configuration

Fill in the right values for `<keyfile>`, `<certfile>`, `<domainname>`, `<redirect>`
urls (path the openid connect providers will redirect the user to, with a leading
slash) and the contacts field (at least on valid mail adress).


### Add an openid connect provider

You need the configuration url (should end with .well-known/openid/configuration, cut this part of, it is added automatically).
You also need either:

* A configuration token
* A registration url and a registration token
* Client ID and Client Secret


#### Configuration URL and Token:

Choose a key which arpoc uses internally for the provider.

Add both parameters to the config.yml under
`openid_providers -> <key> -> configuration_url`
`openid_providers -> <key> -> configuration_token`

#### Registration URL and registration token:

If you already registered your client and have a registration token add 
the configuration url, the registration url and the registration token
under to the config.yml file under
`openid_providers -> <key>` using the `configuration_url`, `registration_url`
and `registration_token`.

#### Client ID and Client Secret

Add the configuration url to the config.yml.
Call `arpoc --add-provider <key> --client-id <client_id> --client-secret <client-secret>`


### Add a service you want to protect.

You need the origin url, the proxy url and the key of an access control policy
set (the key of an ac entity in the json file with type policy set).

Choose a key which arpoc will internally use for the service.
Add the origin url and the proxy url (the path under which the service will be
available with a leading slash) using the `origin_URL` and `proxy_url` keys
under `services -> <service key> -> ` to the config.yml

*Now you should be able to access the service.*


## Dependencies

* [pyjwkest](https://github.com/IdentityPython/pyjwkest/) -- a python library for web tokens
* [lark-parser](https://github.com/lark-parser/lark) -- a parser for the access control language
* [pyoidc](https://github.com/OpenIDC/pyoidc) -- a python library for Open ID Connect
* ...




%prep
%autosetup -n ARPOC-0.3.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-ARPOC -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.1-1
- Package Spec generated