deephaven_enterprise.proto.auth_pb2¶

Module Contents¶

class AuthError(*, callStatus=..., message=...)[source]¶

Bases: google.protobuf.message.Message

Enough information to propagate the basics of an AuthException from the server to the client by sending this message in Metadata.

Parameters:

callStatus (Global___CallStatus)
message (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

CALLSTATUS_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

MESSAGE_FIELD_NUMBER: int[source]¶

callStatus: Global___CallStatus[source]¶

message: str[source]¶

class AuthenticateByCookieRequest(*, client_id=..., user_context=..., cookie=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for authenticateByCookieRequest rpc. See the service definition file for details on the rpc request.

Parameters:

client_id (Global___ClientId | None)
user_context (Global___UserContext | None)
cookie (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CLIENT_ID_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

USER_CONTEXT_FIELD_NUMBER: int[source]¶

property client_id: Global___ClientId[source]¶

the new client id for the client making the request.

Return type:: Global___ClientId

cookie: bytes[source]¶: a valid cookie for another client on the same user context.

property user_context: Global___UserContext[source]¶

the credentials desired, which should match the cookie.

Return type:: Global___UserContext

class AuthenticateByCookieResponse(*, result=...)[source]¶

Bases: google.protobuf.message.Message

Request response for replaceClient rpc. See the service definition file for details on the rpc request.

Parameters:: result (Global___AuthenticationResult | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

RESULT_FIELD_NUMBER: int[source]¶

property result: Global___AuthenticationResult[source]¶

Return type:: Global___AuthenticationResult

class AuthenticateByDelegateTokenRequest(*, client_id=..., delegate_token=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for authenticateByDelegateToken rpc. See the service definition file for details on the rpc request.

Parameters:

client_id (Global___ClientId | None)
delegate_token (Global___Token | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CLIENT_ID_FIELD_NUMBER: int[source]¶

DELEGATE_TOKEN_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

property client_id: Global___ClientId[source]¶

Return type:: Global___ClientId

property delegate_token: Global___Token[source]¶

Return type:: Global___Token

class AuthenticateByDelegateTokenResponse(*, result=...)[source]¶

Bases: google.protobuf.message.Message

Request response for authenticateByDelegateToken rpc. See the service definition file for details on the rpc request.

Parameters:: result (Global___AuthenticationResult | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

RESULT_FIELD_NUMBER: int[source]¶

property result: Global___AuthenticationResult[source]¶

Return type:: Global___AuthenticationResult

class AuthenticateByExternalRequest(*, client_id=..., key=..., do_not_forward=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for authenticateByExternal rpc. See the service definition file for details on the rpc request.

Parameters:

client_id (Global___ClientId | None)
key (str)
do_not_forward (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CLIENT_ID_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

DO_NOT_FORWARD_FIELD_NUMBER: int[source]¶

KEY_FIELD_NUMBER: int[source]¶

property client_id: Global___ClientId[source]¶

the client id for the client making the request.

Return type:: Global___ClientId

do_not_forward: bool[source]¶: clients should always send the default of false and otherwise ignore this field, this field is only for auth server implementation use. If true (which can only set by an auth server forwarding to another), only answer the request on the receiving server itself.

key: str[source]¶: the key for external authentication.

class AuthenticateByExternalResponse(*, result=...)[source]¶

Bases: google.protobuf.message.Message

Request response for authenticateByExternal rpc. See the service definition file for details on the rpc request.

Parameters:: result (Global___AuthenticationResult | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

RESULT_FIELD_NUMBER: int[source]¶

property result: Global___AuthenticationResult[source]¶

Return type:: Global___AuthenticationResult

class AuthenticateByPasswordRequest(*, client_id=..., user_context=..., password=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for authenticateByPassword prc. See the service definition file for details on the rpc request.

Parameters:

client_id (Global___ClientId | None)
user_context (Global___UserContext | None)
password (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CLIENT_ID_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

PASSWORD_FIELD_NUMBER: int[source]¶

USER_CONTEXT_FIELD_NUMBER: int[source]¶

property client_id: Global___ClientId[source]¶

the client id for the client making the request.

Return type:: Global___ClientId

password: str[source]¶: the password.

property user_context: Global___UserContext[source]¶

the credentials desired.

Return type:: Global___UserContext

class AuthenticateByPasswordResponse(*, result=...)[source]¶

Bases: google.protobuf.message.Message

Request response for authenticateByPassword rpc. See the service definition file for details on the rpc request.

Parameters:: result (Global___AuthenticationResult | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

RESULT_FIELD_NUMBER: int[source]¶

property result: Global___AuthenticationResult[source]¶

Return type:: Global___AuthenticationResult

class AuthenticateByPublicKeyRequest(*, client_id=..., user_context=..., public_key=..., challenge_response=..., ip_address=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for authenticateByPublicKey rpc. See the service definition file for details on the rpc request.

Parameters:

client_id (Global___ClientId | None)
user_context (Global___UserContext | None)
public_key (bytes)
challenge_response (bytes)
ip_address (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CHALLENGE_RESPONSE_FIELD_NUMBER: int[source]¶

CLIENT_ID_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

IP_ADDRESS_FIELD_NUMBER: int[source]¶

PUBLIC_KEY_FIELD_NUMBER: int[source]¶

USER_CONTEXT_FIELD_NUMBER: int[source]¶

challenge_response: bytes[source]¶: The nonce challenge response, which should have been obtained from processing the result of an earlier getNonce rpc request by the client.

property client_id: Global___ClientId[source]¶

the client id for the client making the request.

Return type:: Global___ClientId

ip_address: bytes[source]¶: the ip address of the server that provided the nonce

public_key: bytes[source]¶: the public key.

property user_context: Global___UserContext[source]¶

the credentials desired.

Return type:: Global___UserContext

class AuthenticateByPublicKeyResponse(*, result=...)[source]¶

Bases: google.protobuf.message.Message

Request response for authenticateByPublicKey rpc. See the service definition file for details on the rpc request.

Parameters:: result (Global___AuthenticationResult | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

RESULT_FIELD_NUMBER: int[source]¶

property result: Global___AuthenticationResult[source]¶

Return type:: Global___AuthenticationResult

class AuthenticationResult(*, authenticated=..., cookie=..., cookie_deadline_time_millis=..., userContext=...)[source]¶

Bases: google.protobuf.message.Message

Servers respond to Authenticate* requests with an opaque cookie for the (client_id, user, effectiveUser) combination granted in the request. clients remember and use the same cookie in subsequent RPCs to the server that intend to use those credentials. This cookie should be refreshed prior to the deadline, which is represented as milliseconds since epoch. Clients are encouraged to refresh considerably in advance of the deadline, as to be able to continue operating under network delays. The expected pattern is for clients to refresh half-way throught their available period from the last refresh to the deadline.

Parameters:

authenticated (bool)
cookie (bytes)
cookie_deadline_time_millis (int)
userContext (Global___UserContext | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

AUTHENTICATED_FIELD_NUMBER: int[source]¶

COOKIE_DEADLINE_TIME_MILLIS_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

USERCONTEXT_FIELD_NUMBER: int[source]¶

authenticated: bool[source]¶: true if authentication was successful.

cookie: bytes[source]¶: the cookie that the client should remember and refresh before its deadline to remain authenticated.

cookie_deadline_time_millis: int[source]¶: the absolute time in milliseconds from the epoch when the cookie will expire.

property userContext: Global___UserContext[source]¶

the user context actually authenticated; if there was one in the request should match it.

Return type:: Global___UserContext

class CallStatus[source]¶

Bases: _CallStatus

Map directly to classes derived from AuthException. If you modify this enum, ensure to keep consistent the mappings to/from it in GrpcAuthenticationService.java and GrpcAuthenticationClientManager.java.

class ClientId(*, name=..., uuid=...)[source]¶

Bases: google.protobuf.message.Message

A unique client identifier sent by clients to introduce themselves to servers.

Parameters:

name (str)
uuid (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

NAME_FIELD_NUMBER: int[source]¶

UUID_FIELD_NUMBER: int[source]¶

name: str[source]¶: A string to identify this client in server side log files. This has no relation to username in authentication, it is exclusively a way for client programs to provide support for ease of debugging, by providing descriptive text. A good example could be python reconciliation script running on machine a.b.c.d. The server will only use this string in the initial logging for a client connection. The intent is to facilitate debugging when an administrator or user of this API needs to find the entries for a given client program in server logs. The protocol is designed so that uuid is enough for tracing unique clients, so this string is not strictly necessary; it may save effort for an admin (or yourself) in tracking down a uuid in a sea of machines however. Libraries built on top of this proto are expected to allow users to provide their own string (hopefully including explanatory documentation for the purpose in their API definition). When users do not provide one, libraries are expected to provide sensible defaults (eg, “python client running on machine a.b.c.d”).

uuid: bytes[source]¶: A client uuid in bytes is created by client library code and used for the lifetime of that client process. A client’s uuid is expected by the server to be unique across all live client channels. If the same client process during its lifetime connects to different server processes, be it on different machines or different server process instances on the same machine (eg, server bounce), the client process is expected to use the same uuid to all servers. Note that uuids are a means for clients and servers to uniquely identify clients in log files; a uuid on its own is not enough to uniquely identify and trust a client session in the server. See ‘cookie’ in other messages below for a unique, and secret, client session identifier. The uuid is a user-visible unique name for a client, that can be used across non-overlapping sessions. The cookie is not user-visible and is provided by the protocol and required by the server to trust messages to have a particular client as origin.

class GetNonceRequest(*, client_id=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for getNonce rpc. See the service definition file for details on the rpc request.

Parameters:: client_id (Global___ClientId | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CLIENT_ID_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

property client_id: Global___ClientId[source]¶

the client id for the client making the request.

Return type:: Global___ClientId

class GetNonceResponse(*, nonce=..., ip_address=...)[source]¶

Bases: google.protobuf.message.Message

Request response for getNonce rpc. See the service definition file for details on the rpc request.

Parameters:

nonce (bytes)
ip_address (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

IP_ADDRESS_FIELD_NUMBER: int[source]¶

NONCE_FIELD_NUMBER: int[source]¶

ip_address: bytes[source]¶: the ip address of the server host that produced the nonce

nonce: bytes[source]¶: the nonce payload

class GetTokenAsRequest(*, cookie=..., service=..., operateAsUser=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for getTokenAs rpc See the service definition file for details on the rpc request.

Parameters:

cookie (bytes)
service (str)
operateAsUser (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

OPERATEASUSER_FIELD_NUMBER: int[source]¶

SERVICE_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶: the cookie for the client making the request.

operateAsUser: str[source]¶: the user as whom the client desires to operate.

service: str[source]¶: the service for which the token is intended.

class GetTokenAsResponse(*, token=...)[source]¶

Bases: google.protobuf.message.Message

Request response for getTokenAs rpc See the service definition file for details on the rpc request.

Parameters:: token (Global___Token | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

TOKEN_FIELD_NUMBER: int[source]¶

property token: Global___Token[source]¶

the token payload

Return type:: Global___Token

class GetTokenRequest(*, cookie=..., service=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for getToken rpc. See the service definition file for details on the rpc request.

Parameters:

cookie (bytes)
service (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

SERVICE_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶: the cookie for the client making the request.

service: str[source]¶: the service for which the token is intended.

class GetTokenResponse(*, token=...)[source]¶

Bases: google.protobuf.message.Message

Request response for getToken rpc. See the service definition file for details on the rpc request.

Parameters:: token (Global___Token | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

TOKEN_FIELD_NUMBER: int[source]¶

property token: Global___Token[source]¶

the token payload

Return type:: Global___Token

class InvalidateCookieRequest(*, cookie=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for invalidateCookie rpc. See the service definition file for details on the rpc request.

Parameters:: cookie (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

cookie: bytes[source]¶: the cookie value to invalidate.

class InvalidateCookieResponse[source]¶

Bases: google.protobuf.message.Message

Request response for invalidateCookie rpc. See the service definition file for details on the rpc request.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class KvClientData(*, hashedCookie=..., userContext=...)[source]¶

Bases: google.protobuf.message.Message

This message is not used in requests/responses, but to serialize/deserialize the information associated with a uuid client (KV key) with its payload (KV value) in etcd.

Parameters:

hashedCookie (bytes)
userContext (Global___UserContext | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

HASHEDCOOKIE_FIELD_NUMBER: int[source]¶

USERCONTEXT_FIELD_NUMBER: int[source]¶

hashedCookie: bytes[source]¶

property userContext: Global___UserContext[source]¶

Return type:: Global___UserContext

class RefreshCookieRequest(*, cookie=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for refreshCookie rpc. See the service definition file for details on the rpc request.

Parameters:: cookie (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

cookie: bytes[source]¶: The actual cookie that was handed to the client by the server, that the client is trying to refresh.

class RefreshCookieResponse(*, cookie=..., cookie_deadline_time_millis=...)[source]¶

Bases: google.protobuf.message.Message

Request response for refreshCookie rpc. See the service definition file for details on the rpc request.

Parameters:

cookie (bytes)
cookie_deadline_time_millis (int)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_DEADLINE_TIME_MILLIS_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

cookie: bytes[source]¶: This field is unused.

cookie_deadline_time_millis: int[source]¶: Absolute time expressed as milliseconds from the epoch when cookie expires.

class ReloadRequest[source]¶

Bases: google.protobuf.message.Message

Request argument for reload rpc. See the service definition file for details on the rpc request.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class ReloadResponse(*, result=...)[source]¶

Bases: google.protobuf.message.Message

Request response for reload rpc. See the service definition file for details on the rpc request.

Parameters:: result (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

RESULT_FIELD_NUMBER: int[source]¶

result: str[source]¶: A string that a tool asking for configuration reload can show.

class Token(*, token_id=..., service=..., user_context=..., ip_address=...)[source]¶

Bases: google.protobuf.message.Message

A token is a server-generated identifier for a client that allows the client to present themselves to other services using the token as a means of verifying identity and credentials; the other service can validate a token provided by a client with an authentication server to confirm the claimed identity and credentials.

Parameters:

token_id (int)
service (str)
user_context (Global___UserContext | None)
ip_address (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

IP_ADDRESS_FIELD_NUMBER: int[source]¶

SERVICE_FIELD_NUMBER: int[source]¶

TOKEN_ID_FIELD_NUMBER: int[source]¶

USER_CONTEXT_FIELD_NUMBER: int[source]¶

ip_address: bytes[source]¶: The ip address of the authentication server that produced the token.

service: str[source]¶: The service for which the token is intended.

token_id: int[source]¶: The actual token payload.

property user_context: Global___UserContext[source]¶

The credentials for the token.

Return type:: Global___UserContext

class UserContext(*, authenticatedUser=..., effectiveUser=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

authenticatedUser (str)
effectiveUser (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

AUTHENTICATEDUSER_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

EFFECTIVEUSER_FIELD_NUMBER: int[source]¶

authenticatedUser: str[source]¶

effectiveUser: str[source]¶

class VerifyChallengeRequest(*, server_ip_address=..., client_id=..., user_context=..., public_key=..., challenge_response=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for verifyNonce request. See the service definition file for details on the rpc request.

Parameters:

server_ip_address (bytes)
client_id (Global___ClientId | None)
user_context (Global___UserContext | None)
public_key (bytes)
challenge_response (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CHALLENGE_RESPONSE_FIELD_NUMBER: int[source]¶

CLIENT_ID_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

PUBLIC_KEY_FIELD_NUMBER: int[source]¶

SERVER_IP_ADDRESS_FIELD_NUMBER: int[source]¶

USER_CONTEXT_FIELD_NUMBER: int[source]¶

challenge_response: bytes[source]¶: The nonce challenge response, which should have been obtained from processing the result of an earlier getNonce rpc request by the client on the server receiving this request (“this” server)

property client_id: Global___ClientId[source]¶

the client id for the client making the originating request

Return type:: Global___ClientId

public_key: bytes[source]¶: the public key.

server_ip_address: bytes[source]¶: the ip address of the server making the request on behalf of a client

property user_context: Global___UserContext[source]¶

the credentials desired.

Return type:: Global___UserContext

class VerifyChallengeResponse(*, success=..., userContext=...)[source]¶

Bases: google.protobuf.message.Message

Request response for verifyNonce request. See the service definition file for details on the rpc request.

Parameters:

success (bool)
userContext (Global___UserContext | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

SUCCESS_FIELD_NUMBER: int[source]¶

USERCONTEXT_FIELD_NUMBER: int[source]¶

success: bool[source]¶

property userContext: Global___UserContext[source]¶

The user context that can be actually authenticated; if there was one in the original client request this should match it.

Return type:: Global___UserContext

class VerifyTokenRequest(*, service=..., token=...)[source]¶

Bases: google.protobuf.message.Message

Request argument for verifyToken rpc See the service definition file for details on the rpc request.

Parameters:

service (str)
token (Global___Token | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

SERVICE_FIELD_NUMBER: int[source]¶

TOKEN_FIELD_NUMBER: int[source]¶

service: str[source]¶: the service who received the token and wishes to verify.

property token: Global___Token[source]¶

the token payload for verification.

Return type:: Global___Token

class VerifyTokenResponse(*, token_valid=...)[source]¶

Bases: google.protobuf.message.Message

Request response for verifyToken rpc See the service definition file for details on the rpc request.

Parameters:: token_valid (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

TOKEN_VALID_FIELD_NUMBER: int[source]¶

token_valid: bool[source]¶: whether the token is valid or not.

ALREADY_AUTHENTICATED: CallStatus[source]¶: AlreadyAuthenticatedException

AUTH_ERROR_NON_RETRYABLE: CallStatus[source]¶: AuthException, non-retryable.

AUTH_ERROR_RETRYABLE: CallStatus[source]¶: AuthException, retryable.

DESCRIPTOR: google.protobuf.descriptor.FileDescriptor[source]¶

type Global___AuthError = AuthError[source]¶

type Global___AuthenticateByCookieRequest = AuthenticateByCookieRequest[source]¶

type Global___AuthenticateByCookieResponse = AuthenticateByCookieResponse[source]¶

type Global___AuthenticateByDelegateTokenRequest = AuthenticateByDelegateTokenRequest[source]¶

type Global___AuthenticateByDelegateTokenResponse = AuthenticateByDelegateTokenResponse[source]¶

type Global___AuthenticateByExternalRequest = AuthenticateByExternalRequest[source]¶

type Global___AuthenticateByExternalResponse = AuthenticateByExternalResponse[source]¶

type Global___AuthenticateByPasswordRequest = AuthenticateByPasswordRequest[source]¶

type Global___AuthenticateByPasswordResponse = AuthenticateByPasswordResponse[source]¶

type Global___AuthenticateByPublicKeyRequest = AuthenticateByPublicKeyRequest[source]¶

type Global___AuthenticateByPublicKeyResponse = AuthenticateByPublicKeyResponse[source]¶

type Global___AuthenticationResult = AuthenticationResult[source]¶

type Global___CallStatus = CallStatus[source]¶

type Global___ClientId = ClientId[source]¶

type Global___GetNonceRequest = GetNonceRequest[source]¶

type Global___GetNonceResponse = GetNonceResponse[source]¶

type Global___GetTokenAsRequest = GetTokenAsRequest[source]¶

type Global___GetTokenAsResponse = GetTokenAsResponse[source]¶

type Global___GetTokenRequest = GetTokenRequest[source]¶

type Global___GetTokenResponse = GetTokenResponse[source]¶

type Global___InvalidateCookieRequest = InvalidateCookieRequest[source]¶

type Global___InvalidateCookieResponse = InvalidateCookieResponse[source]¶

type Global___KvClientData = KvClientData[source]¶

type Global___RefreshCookieRequest = RefreshCookieRequest[source]¶

type Global___RefreshCookieResponse = RefreshCookieResponse[source]¶

type Global___ReloadRequest = ReloadRequest[source]¶

type Global___ReloadResponse = ReloadResponse[source]¶

type Global___Token = Token[source]¶

type Global___UserContext = UserContext[source]¶

type Global___VerifyChallengeRequest = VerifyChallengeRequest[source]¶

type Global___VerifyChallengeResponse = VerifyChallengeResponse[source]¶

type Global___VerifyTokenRequest = VerifyTokenRequest[source]¶

type Global___VerifyTokenResponse = VerifyTokenResponse[source]¶

NOT_AUTHENTICATED: CallStatus[source]¶: NotAuthenticatedException

OK: CallStatus[source]¶: No error, everything is fine.

PUB_PRIV_KEY: CallStatus[source]¶: PubPrivKeyException

TOKEN_CREATION: CallStatus[source]¶: TokenCreationException

TOKEN_VERIFICATION: CallStatus[source]¶: TokenVerificationException

UNAVAILABLE: CallStatus[source]¶: UnavailableException