@@ -21,6 +21,7 @@ Basic management of keys in the Linux kernel keyring in Python. Also comes with
2121* [ License] ( #license )
2222
2323
24+
2425# Description
2526
2627This is a small library to make use of some functions of the kernel keyring in Python.
@@ -41,56 +42,46 @@ Available functions:
4142
4243There are many more functions with keys in the kernel keyring (e.g. permissions)
4344that is needed for proper keymanagement. But for my usecase I just needed the
44- given simple functionality.
45+ given simple functionality.
46+
47+ :warning : You might need to link your keyrings (e.g. for the testcases using the default keyring)
48+ to have proper permissions.
49+ E.g.:
50+ ``` sh
51+ $ keyctl link @u @s
52+ ```
4553
4654
4755# Requirements
4856
4957Python 3.9
50- ```
58+ ``` sh
5159$ sudo apt install python3.9
5260$ python --version
53- Python 3.9.12
61+ Python 3.9.18
5462```
5563
5664pip
57- ```
65+ ``` sh
5866$ sudo apt install python3-pip
5967$ pip --version
60- pip 22 .3.1 from .... (python 3.9)
68+ pip 23 .3.2 from .... (python 3.9)
6169```
6270
6371The 'keyctl' command
64- ```
72+ ``` sh
6573$ sudo apt install keyutils
6674$ dpkg -s keyutils | grep Version
67- Version: 1.5.9
75+ Version: 1.6.1
6876```
6977
70- For the GUI you also need:
71-
72- Qt4
78+ If you want to use the GUI, you also need PySide6
7379```
74- $ sudo apt install qt4-qmake libqt4-core libqt4-dev
75- $ qmake-qt4 --version
76- QMake version 2.01a
77- Using Qt version 4.8.1 in /usr/lib/x86_64-linux-gnu
80+ $ pip install pyside6
81+ $ python3 -c "import PySide6; print(PySide6.__version__)"
82+ 6.6.1
7883```
7984
80- PySide
81- ```
82- $ sudo apt install python-qt4 python3-pyside
83- $ python3 -c "import PySide; print(PySide.__version__)"
84- Version: 1.2.2
85- ```
86-
87- Virtualenv:
88- If you want to use gui part of this module in a virtualenv you either have to
89- ` (venv)$ pip install pyside ` (which takes up to 40min to compile)
90- or you can link your pyside distro package into your virtualenv like this:
91- ```
92- $ ln -s /usr/lib/python3/dist-packages/PySide venv/lib/python3.9/site-packages/
93- ```
9485
9586
9687# Installation
@@ -102,6 +93,7 @@ $ pip install keyctl
10293Ready to use.
10394
10495
96+
10597# Usage
10698
10799## Module
@@ -169,6 +161,7 @@ If you run the integrated tests, your user keyring will be cleared.
169161Don't do this when you have active keys e.g. for encryption.
170162
171163
164+
172165# Similar projects
173166
174167Similar projects you might want to check out:
@@ -177,6 +170,7 @@ Similar projects you might want to check out:
177170 * https://github.com/jdukes/pykeyctl (more complete, direct library wrapper)
178171
179172
173+
180174# License
181175
182176GPL-3.0
0 commit comments