9.1.1.1.1.3.1.1. GeoHealthCheck.plugins.resourceauth.resourceauths

9.1.1.1.1.3.1.1.1. Module Contents

9.1.1.1.1.3.1.1.1.1. Classes

NoAuth	Checks if header exists and has given header value.
BasicAuth	Basic authentication.
BearerTokenAuth	Bearer token auth

class GeoHealthCheck.plugins.resourceauth.resourceauths.NoAuth

Bases: GeoHealthCheck.resourceauth.ResourceAuth

Checks if header exists and has given header value. See http://docs.python-requests.org/en/master/user/quickstart

NAME = 'None'

DESCRIPTION = 'Default class for no auth'

PARAM_DEFS

Param defs

verify()

encode()

Encode/encrypt auth dict structure. :return: encoded string

class GeoHealthCheck.plugins.resourceauth.resourceauths.BasicAuth

Bases: GeoHealthCheck.resourceauth.ResourceAuth

Basic authentication.

NAME = 'Basic'

DESCRIPTION = 'Default class for no auth'

PARAM_DEFS

Param defs

verify()

encode_auth_header_val()

Get encoded authorization header value from config data. Authorization scheme-specific.

{
  'type': 'Basic',
  'data': {
    'username': 'the_user',
    'password': 'the_password'
  }
}

Returns:

None or http Basic auth header value

class GeoHealthCheck.plugins.resourceauth.resourceauths.BearerTokenAuth

Bases: GeoHealthCheck.resourceauth.ResourceAuth

Bearer token auth

NAME = 'Bearer Token'

DESCRIPTION = 'Bearer token auth'

PARAM_DEFS

Param defs

verify()

encode_auth_header_val()

Get encoded authorization header value from config data. Authorization scheme-specific.

{
  'type': 'Bearer Token',
  'data': {
      'token': 'the_token'
   }
}

Returns:

None or http auth header value