package auth

Get desktop application:
View/edit binary Protocol Buffers messages

/ This service is responsible for issuing auth tokens to clients for API access.

• rpc GenerateAuthChallenge (GenerateAuthChallengeRequest, GenerateAuthChallengeResponse)

  auth.proto:68

  / Returns a challenge, client is expected to sign this challenge with an appropriate keypair in order to obtain access tokens.

  message GenerateAuthChallengeRequest

  auth.proto:14

  • Role role = 1

    / Role the client is attempting to generate tokens for.

  • bytes pubkey = 2

    / Client's 32 byte pubkey.

  message GenerateAuthChallengeResponse

  auth.proto:22

  • string challenge = 1

• rpc GenerateAuthTokens (GenerateAuthTokensRequest, GenerateAuthTokensResponse)

  auth.proto:71

  / Provides the client with the initial pair of auth tokens for API access.

  message GenerateAuthTokensRequest

  auth.proto:26

  • string challenge = 1

    / The pre-signed challenge.

  • bytes client_pubkey = 2

    / The signing keypair's corresponding 32 byte pubkey.

  • bytes signed_challenge = 3

    / The 64 byte signature of the challenge signed by the client's private key. The private key must correspond to the pubkey passed in the [GenerateAuthChallenge] method. The client is expected to sign the challenge token prepended with their pubkey. For example sign(pubkey, challenge).

  message GenerateAuthTokensResponse

  auth.proto:47

  • optional Token access_token = 1

    / The token granting access to resources.

  • optional Token refresh_token = 2

    / The token used to refresh the access_token. This has a longer TTL than the access_token.

• rpc RefreshAccessToken (RefreshAccessTokenRequest, RefreshAccessTokenResponse)

  auth.proto:74

  / Call this method with a non-expired refresh token to obtain a new access token.

  message RefreshAccessTokenRequest

  auth.proto:55

  • string refresh_token = 1

    / Non-expired refresh token obtained from the [GenerateAuthTokens] method.

  message RefreshAccessTokenResponse

  auth.proto:60

  • optional Token access_token = 1

    / Fresh access_token.

Used in: GenerateAuthChallengeRequest

• RELAYER = 0

• SEARCHER = 1

• VALIDATOR = 2

• SHREDSTREAM_SUBSCRIBER = 3

Used in: GenerateAuthTokensResponse, RefreshAccessTokenResponse

• string value = 1

  / The token.

• optional google.protobuf.Timestamp expires_at_utc = 2

  / When the token will expire.