dl.authClient module

dl.authClient.acToString(s)

acToString – Force a return value to be type ‘string’ for all Python versions.

class dl.authClient.authClient

Bases: object

AUTHCLIENT – Client-side methods to access the Data Lab

Authentication Manager service.

debug(debug_val)

Toggle debug flag.

getConfig(section, param)

Get a value from the configuration file.

getFromURL(svc_url, path, token)

Get something from a URL. Return a ‘response’ object.

getHeaders(token)

Get default tracking headers.

get_profile()

Get the requested service profile.

Parameters:

None

Returns:

profile – The currently requested service profile.

Return type:

str

Example

>>> from dl import authClient
>>> profile = authClient.get_profile()

get_svc_url()

Return the currently-used Authentication Manager service URL.

Parameters:

None

Returns:

service_url – The currently-used Authentication Manager service URL.

Return type:

str

Example

>>> from dl import authClient
>>> service_url = authClient.get_svc_url()

hasAccess(token, resource)

See whether the given token has access to the named Resource.

Parameters:

• token (str) – User login token.

• resource (str) – Resource identifier to check.

Returns:

status – True if user owns or has access, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> status = authClient.hasAccess(token, 'vos://test.dat')

isAlive(svc_url='https://datalab.noirlab.edu/auth')

Check whether the Authentication Manager service at the given URL is

alive and responding. This is a simple call to the root service URL or ping() method.

Parameters:

service_url (str) – The Query Service URL to ping.

Returns:

result – True if service responds properly, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isAlive()

isTokenLoggedIn(token)

See whether the user identified by the token is currently logged in.

Parameters:

token (str) – User login token.

Returns:

status – True if token is marked as logged in, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isTokenLoggedIn(token)

isUserLoggedIn(user)

See whether the user identified by the username is currently logged in.

Parameters:

user (str) – User login name.

Returns:

status – True if user is currently logged in, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isUserLoggedIn('monty')

isValidPassword(user, password)

See whether the password is valid for the user.

Parameters:

• user (str) – User login name.

• password (str) – Password for named user.

Returns:

status – True if password is valid for the user, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isValidPassword('monty', 'python')

isValidToken(token)

See whether the current token is valid.

Parameters:

token (str) – User login token.

Returns:

status – True if token is valid, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isValidToken(token)

isValidUser(user)

See whether the specified user is valid.

Parameters:

user (str) – User login name.

Returns:

status – True if user is a valid user name, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isValidUser('monty')

list_profiles(token, profile=None, format='text')

List the service profiles which can be accessed by the user.

Parameters:

token (str) – Valid auth service token.

Returns:

profiles

Return type:

JSON string

Example

>>> from dl import authClient
>>> profiles = authClient.list_profiles(token, profile, format)

loadConfig()

Read the $HOME/.datalab/dl.conf file.

login(username, password, debug=False, verbose=False)

Authenticate the user with the Authentication Manager service.

We first check for a valid login token in the user’s $HOME/.datalab/ directory and simply return that rather than make a service call to get a new token. If a token exists but is invalid, we remove it and get a new token. In either case, we save the token for later use.

Parameters:

• username (str) – User login name.

• password (str) – User password. If not given, a valid ID token will be searched for in the $HOME/.datalab directory.

• debug (bool) – Method debug flag.

• verbose (bool) – Initialize session to print verbose output messages.

Returns:

token – One-time security token for valid user (identified via username and password).

Return type:

str

Example

>>> from dl import authClient
>>> token = authClient.login('dldemo', 'dldemo')   # get security token

logout(token=None)

Log the user out of Data Lab.

Parameters:

token (str [Optional]) – User login token.

Return type:

‘OK’ string on success, or exception message.

Example

>>> from dl import authClient
>>> status = authClient.logout()

passwordReset(token, username, password)

Reset a user password. We require that the user provide

either a valid ‘root’ token or the token for the account being reset.

Parameters:

• token (str) – User login token.

• username (str) – User login name.

• password (str) – User password.

Return type:

‘OK’ string on success, or exception message.

Example

>>> from dl import authClient
>>> authClient.passwordReset(token, 'monty', 'python')

retBoolValue(url)

Utility method to call a boolean service at the given URL.

setConfig(section, param, value)

Set a value and save the configuration file.

set_profile(profile)

Set the requested service profile.

Parameters:

profile (str) – Requested service profile.

Return type:

Nothing

Example

>>> from dl import authClient
>>> authClient.set_profile("dev")

set_svc_url(svc_url)

Set the URL of the Authentication Manager service to be used.

Parameters:

svc_url (str) – Authentication Manager service base URL to call.

Return type:

Nothing

Example

>>> from dl import authClient
>>> authClient.set_svc_url("http://localhost:7001/")

whoAmI()

Return the currently logged in user identity.

Parameters:

None

Returns:

name – Currently logged in user name, or ‘anonymous’ if not logged in.

Return type:

str

Example

>>> from dl import authClient
>>> name = authClient.whoAmI()

writeConfig()

Write out the configuration file to disk.

exception dl.authClient.dlAuthError(message)

Bases: Exception

A throwable error class.

dl.authClient.getClient()

Get a new instance of the authClient client.

Parameters:

None

Returns:

client – An authClient object.

Return type:

authClient

Example

>>> from dl import authClient
>>> new_client = authClient.getClient()

dl.authClient.get_profile()

Get the requested service profile.

Parameters:

None

Returns:

profile – The currently requested service profile.

Return type:

str

Example

>>> from dl import authClient
>>> profile = authClient.get_profile()

dl.authClient.get_svc_url()

Return the currently-used Authentication Manager service URL.

Parameters:

None

Returns:

service_url – The currently-used Authentication Manager service URL.

Return type:

str

Example

>>> from dl import authClient
>>> service_url = authClient.get_svc_url()

dl.authClient.hasAccess(user, resource)

See whether the given token has access to the named Resource.

Parameters:

• token (str) – User login token.

• resource (str) – Resource identifier to check.

Returns:

status – True if user owns or has access, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> status = authClient.hasAccess(token, 'vos://test.dat')

dl.authClient.isAlive(svc_url='https://datalab.noirlab.edu/auth')

Check whether the Authentication Manager service at the given URL is

alive and responding. This is a simple call to the root service URL or ping() method.

Parameters:

service_url (str) – The Query Service URL to ping.

Returns:

result – True if service responds properly, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isAlive()

dl.authClient.isTokenLoggedIn(token)

See whether the user identified by the token is currently logged in.

Parameters:

token (str) – User login token.

Returns:

status – True if token is marked as logged in, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isTokenLoggedIn(token)

dl.authClient.isUserLoggedIn(user)

See whether the user identified by the username is currently logged in.

Parameters:

user (str) – User login name.

Returns:

status – True if user is currently logged in, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isUserLoggedIn('monty')

dl.authClient.isValidPassword(user, password)

See whether the password is valid for the user.

Parameters:

• user (str) – User login name.

• password (str) – Password for named user.

Returns:

status – True if password is valid for the user, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isValidPassword('monty', 'python')

dl.authClient.isValidToken(token)

See whether the current token is valid.

Parameters:

token (str) – User login token.

Returns:

status – True if token is valid, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isValidToken(token)

dl.authClient.isValidUser(user)

See whether the specified user is valid.

Parameters:

user (str) – User login name.

Returns:

status – True if user is a valid user name, False otherwise.

Return type:

bool

Example

>>> from dl import authClient
>>> authClient.isValidUser('monty')

dl.authClient.list_profiles(token, profile=None, format='text')

dl.authClient.login(user, password=None, debug=False, verbose=False)

Authenticate the user with the Authentication Manager service.

We first check for a valid login token in the user’s $HOME/.datalab/ directory and simply return that rather than make a service call to get a new token. If a token exists but is invalid, we remove it and get a new token. In either case, we save the token for later use.

Parameters:

• username (str) – User login name.

• password (str) – User password. If not given, a valid ID token will be searched for in the $HOME/.datalab directory.

• debug (bool) – Method debug flag.

• verbose (bool) – Initialize session to print verbose output messages.

Returns:

token – One-time security token for valid user (identified via username and password).

Return type:

str

Example

>>> from dl import authClient
>>> token = authClient.login('dldemo', 'dldemo')   # get security token

dl.authClient.logout(token=None)

Log the user out of Data Lab.

Parameters:

token (str [Optional]) – User login token.

Return type:

‘OK’ string on success, or exception message.

Example

>>> from dl import authClient
>>> status = authClient.logout()

dl.authClient.passwordReset(token, username, password)

Reset a user password. We require that the user provide

either a valid ‘root’ token or the token for the account being reset.

Parameters:

• token (str) – User login token.

• username (str) – User login name.

• password (str) – User password.

Return type:

‘OK’ string on success, or exception message.

Example

>>> from dl import authClient
>>> authClient.passwordReset(token, 'monty', 'python')

dl.authClient.set_profile(profile)

Set the requested service profile.

Parameters:

profile (str) – Requested service profile.

Return type:

Nothing

Example

>>> from dl import authClient
>>> authClient.set_profile("dev")

dl.authClient.set_svc_url(svc_url)

Set the URL of the Authentication Manager service to be used.

Parameters:

svc_url (str) – Authentication Manager service base URL to call.

Return type:

Nothing

Example

>>> from dl import authClient
>>> authClient.set_svc_url("http://localhost:7001/")

dl.authClient.whoAmI()

Return the currently logged in user identity.

Parameters:

None

Returns:

name – Currently logged in user name, or ‘anonymous’ if not logged in.

Return type:

str

Example

>>> from dl import authClient
>>> name = authClient.whoAmI()