From fc0f6b4351d0f383fa8c90d9febe2846e7ce4335 Mon Sep 17 00:00:00 2001 From: Alexander Scheel Date: Thu, 16 Aug 2018 22:47:25 -0400 Subject: Add missing docstrings to kernel_keyring.py Signed-off-by: Alexander Scheel Reviewed-By: Florence Blanc-Renaud --- ipapython/kernel_keyring.py | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'ipapython') 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)) -- cgit