[_621] free functions & associated changes (squash)

including: review chgs and codacy recommendations

Author: d-w-moore

irods/__init__.py

@@ -3,6 +3,22 @@
 import logging
 import os
 
+def env_filename_from_keyword_args(kwargs):
+    try:
+        env_file = kwargs.pop('irods_env_file')
+    except KeyError:
+        try:
+            env_file = os.environ['IRODS_ENVIRONMENT_FILE']
+        except KeyError:
+            env_file = os.path.expanduser('~/.irods/irods_environment.json')
+    return env_file
+
+def derived_auth_filename(env_filename):
+    if not env_filename:
+        return ''
+    default_irods_authentication_file = os.path.join(os.path.dirname(env_filename),'.irodsA')
+    return os.environ.get('IRODS_AUTHENTICATION_FILE', default_irods_authentication_file)
+
 # This has no effect if basicConfig() was previously called.
 logging.basicConfig()
 

irods/account.py

@@ -1,10 +1,10 @@
-import os
+from irods import derived_auth_filename
 
 class iRODSAccount(object):
 
     @property
     def derived_auth_file(self):
-        return '' if not self.env_file else os.path.join(os.path.dirname(self.env_file),'.irodsA')
+        return derived_auth_filename(self.env_file)
 
     def __init__(self, irods_host, irods_port, irods_user_name, irods_zone_name,
                  irods_authentication_scheme='native',

irods/client_init.py

@@ -0,0 +1,34 @@
+from irods import (env_filename_from_keyword_args, derived_auth_filename)
+import irods.client_configuration as cfg
+import irods.password_obfuscation as obf
+import irods.helpers as h
+import getpass
+import sys
+
+def write_native_credentials_to_secrets_file(password, **kw):
+    env_file = env_filename_from_keyword_args(kw)
+    auth_file = derived_auth_filename(env_file)
+    open(auth_file,'w').write(obf.encode(password))
+    return True
+
+def write_pam_credentials_to_secrets_file( password ,**kw):
+    s = h.make_session()
+    s.pool.account.password = password
+    with cfg.loadlines( [dict(setting='legacy_auth.pam.password_for_auto_renew',value=None),
+                         dict(setting='legacy_auth.pam.store_password_to_environment',value=False)] ):
+        to_encode = s.pam_pw_negotiated
+    if to_encode:
+        open(s.pool.account.derived_auth_file,'w').write(obf.encode(to_encode[0]))
+        return True
+    return False
+
+if __name__ == '__main__':
+    vector = {
+        'pam_password': write_pam_credentials_to_secrets_file,
+        'native': write_native_credentials_to_secrets_file
+    }
+
+    if sys.argv[1] in vector:
+        vector[sys.argv[1]](getpass.getpass(prompt=f'{sys.argv[1]} password: '))
+    else:
+        print('did not recognize authentication scheme argument',file = sys.stderr)

irods/connection.py

@@ -461,16 +461,14 @@ def _login_pam(self):
 
         import irods.client_configuration as cfg
         inline_password = (self.account.authentication_scheme == self.account._original_authentication_scheme)
-        # By default, let server determine the TTL.
-        time_to_live_in_hours = 0
+        time_to_live_in_hours = cfg.legacy_auth.pam.time_to_live_in_hours
         # For certain characters in the pam password, if they need escaping with '\' then do so.
         new_pam_password = PAM_PW_ESC_PATTERN.sub(lambda m: '\\'+m.group(1), self.account.password)
-        if not inline_password:
+        if not inline_password and cfg.legacy_auth.pam.password_for_auto_renew is not None:
             # Login using PAM password from .irodsA
             try:
                 self._login_native()
             except (ex.CAT_PASSWORD_EXPIRED, ex.CAT_INVALID_USER, ex.CAT_INVALID_AUTHENTICATION) as exc:
-                time_to_live_in_hours = cfg.legacy_auth.pam.time_to_live_in_hours
                 if cfg.legacy_auth.pam.password_for_auto_renew:
                     new_pam_password = cfg.legacy_auth.pam.password_for_auto_renew
                     # Fall through and retry the native login later, after creating a new PAM password

irods/test/helpers.py

@@ -21,6 +21,7 @@
 from irods.session import iRODSSession
 from irods.message import (iRODSMessage, IRODS_VERSION)
 from irods.password_obfuscation import encode
+from irods import env_filename_from_keyword_args
 from six.moves import range
 
 class iRODSUserLogins(object):
@@ -148,7 +149,6 @@ def recast(k):
     os.chmod(auth,0o600)
     return (config, auth)
 
-
 # Create a connection for test, based on ~/.irods environment by default.
 
 def make_session(test_server_version = True, **kwargs):
@@ -166,13 +166,7 @@ def make_session(test_server_version = True, **kwargs):
     **kwargs:            Keyword arguments.  Fed directly to the iRODSSession
                          constructor.  """
 
-    try:
-        env_file = kwargs.pop('irods_env_file')
-    except KeyError:
-        try:
-            env_file = os.environ['IRODS_ENVIRONMENT_FILE']
-        except KeyError:
-            env_file = os.path.expanduser('~/.irods/irods_environment.json')
+    env_file = env_filename_from_keyword_args( kwargs )
     session = iRODSSession( irods_env_file = env_file, **kwargs )
     if test_server_version:
         connected_version = session.server_version[:3]