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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
%global _empty_manifest_terminate_build 0
Name: python-krb5
Version: 0.5.0
Release: 1
Summary: Kerberos API bindings for Python
License: MIT
URL: https://github.com/jborean93/pykrb5
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/58/e3/50ce47968c1ae283b99410ebb6eaa595b2f016f35f15a9d11426db65ae3e/krb5-0.5.0.tar.gz
BuildArch: noarch
%description
# Python Kerberos 5 Library
[](https://github.com/jborean93/pykrb5/actions/workflows/ci.yml)
[](https://badge.fury.io/py/krb5)
[](https://github.com/jborean93/pykrb5/blob/main/LICENSE)
This library provides Python functions that wraps the Kerberos 5 C API.
Due to the complex nature of this API it is highly recommended to use something like [python-gssapi](https://github.com/pythongssapi/python-gssapi) which exposes the Kerberos authentication details through GSSAPI.
## Requirements
* An implementation of the Kerberos 5 API - including the header files
* [MIT Kebreros](https://web.mit.edu/kerberos/)
* [Heimdal](https://github.com/heimdal/heimdal)
* A C compiler, such as GCC
* Python 3.6+
_Note: macOS includes their own implementation of Heimdal and a compiler isn't needed on that platform if installing from the wheel._
## Installation
Simply run:
```bash
pip install krb5
```
To install from source run the following:
```bash
git clone https://github.com/jborean93/pykrb5.git
python -m pip install build
python -m build
pip install dist/krb5-*.whl
```
Compiling the code should automatically pick up the proper paths for the KRB5 headers and locations.
If further customisation is needed, the following environment variables can be set when building the wheel:
* `KRB5_KRB5CONFIG`
* The path to `krb5-config` to use for detecting the Kerberos library to link to
* The compiler and linker args are derived from what this function outputs
* Defaults to whatever `krb5-config` is on the `PATH`
* FreeBSD will default to `/usr/local/bin/krb5-config` instead of `/usr/bin/krb5-config`
* `KRB5_MAIN_LIB`
* The path to the `libkrb5` shared library used to check if any of the optional functions are available
* `KRB5_COMPILER_ARGS`
* Compiler flags to use when compiling the extensions
* Defaults to the output of `krb5-config --cflags krb5` if not set
* `KRB5_LINKER_ARGS`
* Linker flags to use when compiling the extensions
* Defaults to the output of `krb5-config --libs krb5` if not set
* `KRB5_SKIP_MODULE_CHECK`
* Skips the checks used to detect if optional functions are available - will treat them all as available
* This is only really useful when building the sdist as no implementation provides all these functions
* `KRB5_CYTHON_TRACING`
* Used to generate the Cython extensions with line tracing for coverage collection
* `KRB5_MACOS_HEIMDAL_DIR`
* Used when compiling on macOS to point to the Heimdal install directory
* Used to find the Heimdal header files as macOS does not include, or provide a way to obtain, these header files for their Heimdal framework
* Defaults to `{git_root}/build_helpers/heimdal`
## Development
To run the tests or make changes to this repo run the following:
```bash
git clone https://github.com/jborean93/pykrb5.git
pip install -r requirements-dev.txt
pre-commit install
python -m pip install -e .
# Can compile the krb5 extensions on an adhoc basis
# python setup.py build_ext --inplace
```
From there an editor like VSCode can be used to make changes and run the test suite.
To recompile the Cython files after a change run the `build_ext --inplace` command.
## Structure
This library is merely a wrapper around the Kerberos 5 APIs.
The functions under the `krb5` namespace match the KRB5 API specification but with the `krb5_` prefix remove.
For example the [krb5_init_context](https://web.mit.edu/kerberos/krb5-devel/doc/appdev/refs/api/krb5_init_context.html) function is called through `krb5.init_context()`.
Errors are raised as a `Krb5Error` which contains the message as formatted by the KRB5 implementation and the error code for that error.
Some of the structures returned by these functions are represented by a Python class and are freed once they are deallocated once all references to that object is removed.
Some classes expose an `addr` property that returns the raw pointer address of the structure it is wrapping.
This is so the structure can be used in other libraries like `python-gssapi` but great care must be taken that nothing else frees the structure as that could cause a segmentation fault.
Not all the functions exposed in this library are available on every KRB5 API implementation.
To check if a function is available run the following:
```python
import krb5
if not hasattr(krb5, "kt_dup"):
raise Exception("Current implementation does not support krb5_kt_dup")
```
There may also be some difference in behaviour, error codes, error messages, between te different implementations.
It is up to the caller to paper over these differences when required.
%package -n python3-krb5
Summary: Kerberos API bindings for Python
Provides: python-krb5
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-krb5
# Python Kerberos 5 Library
[](https://github.com/jborean93/pykrb5/actions/workflows/ci.yml)
[](https://badge.fury.io/py/krb5)
[](https://github.com/jborean93/pykrb5/blob/main/LICENSE)
This library provides Python functions that wraps the Kerberos 5 C API.
Due to the complex nature of this API it is highly recommended to use something like [python-gssapi](https://github.com/pythongssapi/python-gssapi) which exposes the Kerberos authentication details through GSSAPI.
## Requirements
* An implementation of the Kerberos 5 API - including the header files
* [MIT Kebreros](https://web.mit.edu/kerberos/)
* [Heimdal](https://github.com/heimdal/heimdal)
* A C compiler, such as GCC
* Python 3.6+
_Note: macOS includes their own implementation of Heimdal and a compiler isn't needed on that platform if installing from the wheel._
## Installation
Simply run:
```bash
pip install krb5
```
To install from source run the following:
```bash
git clone https://github.com/jborean93/pykrb5.git
python -m pip install build
python -m build
pip install dist/krb5-*.whl
```
Compiling the code should automatically pick up the proper paths for the KRB5 headers and locations.
If further customisation is needed, the following environment variables can be set when building the wheel:
* `KRB5_KRB5CONFIG`
* The path to `krb5-config` to use for detecting the Kerberos library to link to
* The compiler and linker args are derived from what this function outputs
* Defaults to whatever `krb5-config` is on the `PATH`
* FreeBSD will default to `/usr/local/bin/krb5-config` instead of `/usr/bin/krb5-config`
* `KRB5_MAIN_LIB`
* The path to the `libkrb5` shared library used to check if any of the optional functions are available
* `KRB5_COMPILER_ARGS`
* Compiler flags to use when compiling the extensions
* Defaults to the output of `krb5-config --cflags krb5` if not set
* `KRB5_LINKER_ARGS`
* Linker flags to use when compiling the extensions
* Defaults to the output of `krb5-config --libs krb5` if not set
* `KRB5_SKIP_MODULE_CHECK`
* Skips the checks used to detect if optional functions are available - will treat them all as available
* This is only really useful when building the sdist as no implementation provides all these functions
* `KRB5_CYTHON_TRACING`
* Used to generate the Cython extensions with line tracing for coverage collection
* `KRB5_MACOS_HEIMDAL_DIR`
* Used when compiling on macOS to point to the Heimdal install directory
* Used to find the Heimdal header files as macOS does not include, or provide a way to obtain, these header files for their Heimdal framework
* Defaults to `{git_root}/build_helpers/heimdal`
## Development
To run the tests or make changes to this repo run the following:
```bash
git clone https://github.com/jborean93/pykrb5.git
pip install -r requirements-dev.txt
pre-commit install
python -m pip install -e .
# Can compile the krb5 extensions on an adhoc basis
# python setup.py build_ext --inplace
```
From there an editor like VSCode can be used to make changes and run the test suite.
To recompile the Cython files after a change run the `build_ext --inplace` command.
## Structure
This library is merely a wrapper around the Kerberos 5 APIs.
The functions under the `krb5` namespace match the KRB5 API specification but with the `krb5_` prefix remove.
For example the [krb5_init_context](https://web.mit.edu/kerberos/krb5-devel/doc/appdev/refs/api/krb5_init_context.html) function is called through `krb5.init_context()`.
Errors are raised as a `Krb5Error` which contains the message as formatted by the KRB5 implementation and the error code for that error.
Some of the structures returned by these functions are represented by a Python class and are freed once they are deallocated once all references to that object is removed.
Some classes expose an `addr` property that returns the raw pointer address of the structure it is wrapping.
This is so the structure can be used in other libraries like `python-gssapi` but great care must be taken that nothing else frees the structure as that could cause a segmentation fault.
Not all the functions exposed in this library are available on every KRB5 API implementation.
To check if a function is available run the following:
```python
import krb5
if not hasattr(krb5, "kt_dup"):
raise Exception("Current implementation does not support krb5_kt_dup")
```
There may also be some difference in behaviour, error codes, error messages, between te different implementations.
It is up to the caller to paper over these differences when required.
%package help
Summary: Development documents and examples for krb5
Provides: python3-krb5-doc
%description help
# Python Kerberos 5 Library
[](https://github.com/jborean93/pykrb5/actions/workflows/ci.yml)
[](https://badge.fury.io/py/krb5)
[](https://github.com/jborean93/pykrb5/blob/main/LICENSE)
This library provides Python functions that wraps the Kerberos 5 C API.
Due to the complex nature of this API it is highly recommended to use something like [python-gssapi](https://github.com/pythongssapi/python-gssapi) which exposes the Kerberos authentication details through GSSAPI.
## Requirements
* An implementation of the Kerberos 5 API - including the header files
* [MIT Kebreros](https://web.mit.edu/kerberos/)
* [Heimdal](https://github.com/heimdal/heimdal)
* A C compiler, such as GCC
* Python 3.6+
_Note: macOS includes their own implementation of Heimdal and a compiler isn't needed on that platform if installing from the wheel._
## Installation
Simply run:
```bash
pip install krb5
```
To install from source run the following:
```bash
git clone https://github.com/jborean93/pykrb5.git
python -m pip install build
python -m build
pip install dist/krb5-*.whl
```
Compiling the code should automatically pick up the proper paths for the KRB5 headers and locations.
If further customisation is needed, the following environment variables can be set when building the wheel:
* `KRB5_KRB5CONFIG`
* The path to `krb5-config` to use for detecting the Kerberos library to link to
* The compiler and linker args are derived from what this function outputs
* Defaults to whatever `krb5-config` is on the `PATH`
* FreeBSD will default to `/usr/local/bin/krb5-config` instead of `/usr/bin/krb5-config`
* `KRB5_MAIN_LIB`
* The path to the `libkrb5` shared library used to check if any of the optional functions are available
* `KRB5_COMPILER_ARGS`
* Compiler flags to use when compiling the extensions
* Defaults to the output of `krb5-config --cflags krb5` if not set
* `KRB5_LINKER_ARGS`
* Linker flags to use when compiling the extensions
* Defaults to the output of `krb5-config --libs krb5` if not set
* `KRB5_SKIP_MODULE_CHECK`
* Skips the checks used to detect if optional functions are available - will treat them all as available
* This is only really useful when building the sdist as no implementation provides all these functions
* `KRB5_CYTHON_TRACING`
* Used to generate the Cython extensions with line tracing for coverage collection
* `KRB5_MACOS_HEIMDAL_DIR`
* Used when compiling on macOS to point to the Heimdal install directory
* Used to find the Heimdal header files as macOS does not include, or provide a way to obtain, these header files for their Heimdal framework
* Defaults to `{git_root}/build_helpers/heimdal`
## Development
To run the tests or make changes to this repo run the following:
```bash
git clone https://github.com/jborean93/pykrb5.git
pip install -r requirements-dev.txt
pre-commit install
python -m pip install -e .
# Can compile the krb5 extensions on an adhoc basis
# python setup.py build_ext --inplace
```
From there an editor like VSCode can be used to make changes and run the test suite.
To recompile the Cython files after a change run the `build_ext --inplace` command.
## Structure
This library is merely a wrapper around the Kerberos 5 APIs.
The functions under the `krb5` namespace match the KRB5 API specification but with the `krb5_` prefix remove.
For example the [krb5_init_context](https://web.mit.edu/kerberos/krb5-devel/doc/appdev/refs/api/krb5_init_context.html) function is called through `krb5.init_context()`.
Errors are raised as a `Krb5Error` which contains the message as formatted by the KRB5 implementation and the error code for that error.
Some of the structures returned by these functions are represented by a Python class and are freed once they are deallocated once all references to that object is removed.
Some classes expose an `addr` property that returns the raw pointer address of the structure it is wrapping.
This is so the structure can be used in other libraries like `python-gssapi` but great care must be taken that nothing else frees the structure as that could cause a segmentation fault.
Not all the functions exposed in this library are available on every KRB5 API implementation.
To check if a function is available run the following:
```python
import krb5
if not hasattr(krb5, "kt_dup"):
raise Exception("Current implementation does not support krb5_kt_dup")
```
There may also be some difference in behaviour, error codes, error messages, between te different implementations.
It is up to the caller to paper over these differences when required.
%prep
%autosetup -n krb5-0.5.0
%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-krb5 -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.5.0-1
- Package Spec generated
|
