librespot-python/proto/client_token.proto

syntax = "proto3";

package spotify.clienttoken.http.v0;

import "connectivity.proto";

option optimize_for = CODE_SIZE;
option java_package = "com.spotify.clienttoken.http.v0";

message ClientTokenRequest {
    ClientTokenRequestType request_type = 1;

    oneof request {
        ClientDataRequest client_data = 2;
        ChallengeAnswersRequest challenge_answers = 3;
    }
}

message ClientDataRequest {
    string client_version = 1;
    string client_id = 2;

    oneof data {
        data.v0.ConnectivitySdkData connectivity_sdk_data = 3;
    }
}

message ChallengeAnswersRequest {
    string state = 1;
    repeated ChallengeAnswer answers = 2;
}

message ClientTokenResponse {
    ClientTokenResponseType response_type = 1;

    oneof response {
        GrantedTokenResponse granted_token = 2;
        ChallengesResponse challenges = 3;
    }
}

message TokenDomain {
    string domain = 1;
}

message GrantedTokenResponse {
    string token = 1;
    int32 expires_after_seconds = 2;
    int32 refresh_after_seconds = 3;
    repeated TokenDomain domains = 4;
}

message ChallengesResponse {
    string state = 1;
    repeated Challenge challenges = 2;
}

message ClientSecretParameters {
    string salt = 1;
}

message EvaluateJSParameters {
    string code = 1;
    repeated string libraries = 2;
}

message HashCashParameters {
    int32 length = 1;
    string prefix = 2;
}

message Challenge {
    ChallengeType type = 1;

    oneof parameters {
        ClientSecretParameters client_secret_parameters = 2;
        EvaluateJSParameters evaluate_js_parameters = 3;
        HashCashParameters evaluate_hashcash_parameters = 4;
    }
}

message ClientSecretHMACAnswer {
    string hmac = 1;
}

message EvaluateJSAnswer {
    string result = 1;
}

message HashCashAnswer {
    string suffix = 1;
}

message ChallengeAnswer {
    ChallengeType ChallengeType = 1;

    oneof answer {
        ClientSecretHMACAnswer client_secret = 2;
        EvaluateJSAnswer evaluate_js = 3;
        HashCashAnswer hash_cash = 4;
    }
}

message ClientTokenBadRequest {
    string message = 1;
}

enum ClientTokenRequestType {
    REQUEST_UNKNOWN = 0;
    REQUEST_CLIENT_DATA_REQUEST = 1;
    REQUEST_CHALLENGE_ANSWERS_REQUEST = 2;
}

enum ClientTokenResponseType {
    RESPONSE_UNKNOWN = 0;
    RESPONSE_GRANTED_TOKEN_RESPONSE = 1;
    RESPONSE_CHALLENGES_RESPONSE = 2;
}

enum ChallengeType {
    CHALLENGE_UNKNOWN = 0;
    CHALLENGE_CLIENT_SECRET_HMAC = 1;
    CHALLENGE_EVALUATE_JS = 2;
    CHALLENGE_HASH_CASH = 3;
}