credentials Namespace Reference

Functions
def	get_credentials (machine, authPath=None)
def	get_credentials_for_schema (service, schema, role, authPath=None)
def	get_credentials_from_file (machine, authPath)
def	netrc_machine (service, role)

Variables
string	admin_role = 'admin'
string	authPathEnvVar = 'COND_AUTH_PATH'
string	dbkey_filename = 'db.key'
	dbkey_folder = os.path.join('.cms_cond',dbkey_filename)
string	defAuthPathEnvVar = 'HOME'
string	netrcFileName = '.netrc'
string	reader_role = 'reader'
string	writer_role = 'writer'

Function Documentation

get_credentials()

def credentials.get_credentials	(		machine,
			authPath = None
	)

Definition at line 26 of file credentials.py.

References get_credentials_from_file().

Referenced by db_credentials.get_db_credentials().

def get_credentials( machine, authPath=None ):
    if authPath is None:
        if authPathEnvVar in os.environ:
            authPath = os.environ[authPathEnvVar]
        else:
            if defAuthPathEnvVar in os.environ:
                authPath = os.environ[defAuthPathEnvVar]
            else:
                authPath = ''
    return get_credentials_from_file( machine, authPath )

get_credentials_for_schema()

def credentials.get_credentials_for_schema	(		service,
			schema,
			role,
			authPath = None
	)

Definition at line 37 of file credentials.py.

def get_credentials_for_schema( service, schema, role, authPath=None ):
    if authPath is None:
        if authPathEnvVar in os.environ:
            authPath = os.environ[authPathEnvVar]
        else:
            if defAuthPathEnvVar in os.environ:
                authPath = os.environ[defAuthPathEnvVar]
            else:
                authPath = ''
    dbkey_path = os.path.join(authPath,dbkey_folder)
    if not os.path.exists(dbkey_path):
        authFile = os.path.join(authPath,'.netrc')
        if not os.path.exists(authFile):
            raise Exception("Can't get db credentials, since neither db key nor Netrc file have been found.")
        machine = '%s@%s.%s' %(role,schema.lower(),service)
        logging.debug('Looking up db credentials %s in file %s ' %(machine,authFile) )
        import netrc
        params = netrc.netrc( authFile ).authenticators(machine)
        if params is None:
            msg = 'The required credentials have not been found in the .netrc file.' 
            raise Exception(msg)
        return params
    else:
        import libCondDBPyBind11Interface as credential_db
        roles_map = { reader_role: credential_db.reader_role, writer_role: credential_db.writer_role, admin_role: credential_db.admin_role }
        connection_string = 'oracle://%s/%s'%(service.lower(),schema.upper())
        logging.debug('Looking up db credentials for %s in credential store' %connection_string )
        (dbuser,username,password) = credential_db.get_credentials_from_db(connection_string,roles_map[role],authPath)
        if username=='' or password=='':
            raise Exception('No credentials found to connect on %s with the required access role.'%connection_string)       
        return (username,dbuser,password)

get_credentials_from_file()

def credentials.get_credentials_from_file	(		machine,
			authPath
	)

Definition at line 19 of file credentials.py.

Referenced by get_credentials().

def get_credentials_from_file( machine, authPath ):
    authFile = netrcFileName
    if not authPath is None:
        authFile = os.path.join( authPath, authFile )
    creds = netrc.netrc( authFile ).authenticators(machine)
    return creds

netrc_machine()

def credentials.netrc_machine	(		service,
			role
	)

Definition at line 16 of file credentials.py.

def netrc_machine( service, role ):
    return '%s@%s' %(role,service)

Variable Documentation

admin_role

string credentials.admin_role = 'admin'

Definition at line 14 of file credentials.py.

authPathEnvVar

string credentials.authPathEnvVar = 'COND_AUTH_PATH'

Definition at line 7 of file credentials.py.

dbkey_filename

string credentials.dbkey_filename = 'db.key'

Definition at line 9 of file credentials.py.

dbkey_folder

credentials.dbkey_folder = os.path.join('.cms_cond',dbkey_filename)

Definition at line 10 of file credentials.py.

defAuthPathEnvVar

string credentials.defAuthPathEnvVar = 'HOME'

Definition at line 6 of file credentials.py.

netrcFileName

string credentials.netrcFileName = '.netrc'

Definition at line 5 of file credentials.py.

reader_role

string credentials.reader_role = 'reader'

Definition at line 12 of file credentials.py.

writer_role

string credentials.writer_role = 'writer'

Definition at line 13 of file credentials.py.

---

Generated for CMSSW Reference Manual by  1.8.14