diff options
| author | Alexander Scheel <ascheel@redhat.com> | 2018-08-16 22:47:25 -0400 |
|---|---|---|
| committer | Rob Crittenden <rcritten@redhat.com> | 2018-08-20 17:58:16 -0400 |
| commit | fc0f6b4351d0f383fa8c90d9febe2846e7ce4335 (patch) | |
| tree | ab8f3b74f386dd27bde4d710440acf27bbc1b7b8 /ipapython | |
| parent | 3322aad7daffdff33eb520f051ddf2217f731920 (diff) | |
| download | freeipa-fc0f6b4351d0f383fa8c90d9febe2846e7ce4335.tar.gz freeipa-fc0f6b4351d0f383fa8c90d9febe2846e7ce4335.tar.xz freeipa-fc0f6b4351d0f383fa8c90d9febe2846e7ce4335.zip | |
Add missing docstrings to kernel_keyring.py
Signed-off-by: Alexander Scheel <ascheel@redhat.com>
Reviewed-By: Florence Blanc-Renaud <frenaud@redhat.com>
Diffstat (limited to 'ipapython')
| -rw-r--r-- | ipapython/kernel_keyring.py | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/ipapython/kernel_keyring.py b/ipapython/kernel_keyring.py index 6ae1e7449..11b987194 100644 --- a/ipapython/kernel_keyring.py +++ b/ipapython/kernel_keyring.py @@ -60,6 +60,12 @@ def get_real_key(key): def get_persistent_key(key): + """ + Fetches the value of a persistent key from storage, trimming trailing + any tailing whitespace. + + Assert when key is not a string-type. + """ assert isinstance(key, six.string_types) result = run([paths.KEYCTL, 'get_persistent', KEYRING, key], raiseonerr=False, capture_output=True) @@ -69,6 +75,9 @@ def get_persistent_key(key): def is_persistent_keyring_supported(): + """ + Returns True if the kernel persistent keyring is supported. + """ uid = os.geteuid() try: get_persistent_key(str(uid)) |