Module: nintendo.nex.authentication

Provides a client and server for the AuthenticationProtocol and AuthenticationProtocolNX. This page was generated automatically from authentication.proto.

class AuthenticationClient
The client for the AuthenticationProtocol.

class AuthenticationClientNX
The client for the AuthenticationProtocolNX.

class AuthenticationServer
The server for the AuthenticationProtocol.

class AuthenticationServerNX
The server for the AuthenticationProtocolNX.

class AuthenticationInfo(Data)
class RVConnectionData(Structure)
class ValidateAndRequestTicketParam(Structure)
class ValidateAndRequestTicketResult(Structure)

AuthenticationClient

def __init__(client: RMCClient / HppClient)
Creates a new AuthenticationClient.

async def login(username: str) -> RMCResponse
Calls method 1 on the server. The RMC response has the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData
server_name: str

async def login_ex(username: str, extra_data: Data) -> RMCResponse
Calls method 2 on the server. The RMC response has the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData
server_name: str

async def request_ticket(source: int, target: int) -> RMCResponse
Calls method 3 on the server. The RMC response has the following attributes:
result: Result
ticket: bytes

async def get_pid(username: str) -> int
Calls method 4 on the server.

async def get_name(pid: int) -> str
Calls method 5 on the server.

async def login_with_context(login_data: Data) -> RMCResponse
Calls method 6 on the server. The RMC response has the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData

AuthenticationClientNX

def __init__(client: RMCClient / HppClient)
Creates a new AuthenticationClientNX.

async def validate_and_request_ticket(username: str) -> RMCResponse
Calls method 1 on the server. The RMC response has the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData
server_name: str

async def validate_and_request_ticket_with_custom_data(username: str, extra_data: Data) -> RMCResponse
Calls method 2 on the server. The RMC response has the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData
server_name: str
source_key: str

async def request_ticket(source: int, target: int) -> RMCResponse
Calls method 3 on the server. The RMC response has the following attributes:
result: Result
ticket: bytes
key: str

async def get_pid(username: str) -> int
Calls method 4 on the server.

async def get_name(pid: int) -> str
Calls method 5 on the server.

async def validate_and_request_ticket_with_param(param: ValidateAndRequestTicketParam) -> ValidateAndRequestTicketResult
Calls method 6 on the server.

AuthenticationServer

def __init__()
Creates a new AuthenticationServer.

async def logout(client: RMCClient) -> None
Called whenever a client is disconnected. May be overridden by a subclass.

async def login(client: RMCClient, username: str) -> RMCResponse
Handler for method 1. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData
server_name: str

async def login_ex(client: RMCClient, username: str, extra_data: Data) -> RMCResponse
Handler for method 2. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData
server_name: str

async def request_ticket(client: RMCClient, source: int, target: int) -> RMCResponse
Handler for method 3. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: Result
ticket: bytes

async def get_pid(client: RMCClient, username: str) -> int
Handler for method 4. This method should be overridden by a subclass.

async def get_name(client: RMCClient, pid: int) -> str
Handler for method 5. This method should be overridden by a subclass.

async def login_with_context(client: RMCClient, login_data: Data) -> RMCResponse
Handler for method 6. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData

AuthenticationServerNX

def __init__()
Creates a new AuthenticationServerNX.

async def logout(client: RMCClient) -> None
Called whenever a client is disconnected. May be overridden by a subclass.

async def validate_and_request_ticket(client: RMCClient, username: str) -> RMCResponse
Handler for method 1. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData
server_name: str

async def validate_and_request_ticket_with_custom_data(client: RMCClient, username: str, extra_data: Data) -> RMCResponse
Handler for method 2. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: Result
pid: int
ticket: bytes
connection_data: RVConnectionData
server_name: str
source_key: str

async def request_ticket(client: RMCClient, source: int, target: int) -> RMCResponse
Handler for method 3. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: Result
ticket: bytes
key: str

async def get_pid(client: RMCClient, username: str) -> int
Handler for method 4. This method should be overridden by a subclass.

async def get_name(client: RMCClient, pid: int) -> str
Handler for method 5. This method should be overridden by a subclass.

async def validate_and_request_ticket_with_param(client: RMCClient, param: ValidateAndRequestTicketParam) -> ValidateAndRequestTicketResult
Handler for method 6. This method should be overridden by a subclass.

AuthenticationInfo

def __init__()
Creates a new AuthenticationInfo instance. Required fields must be filled in manually.

The following fields are defined in this class:
token: str
ngs_version: int = 3
token_type: int = 1
server_version: int = 0

RVConnectionData

def __init__()
Creates a new RVConnectionData instance. Required fields must be filled in manually.

The following fields are defined in this class:
main_station: StationURL = "prudp:/"
special_protocols: list[int] = []
special_station: StationURL = "prudp:/"
If nex.version >= 30500:
If revision >= 1:
server_time: DateTime = DateTime.never()

ValidateAndRequestTicketParam

def __init__()
Creates a new ValidateAndRequestTicketParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
platform: int = 3
username: str
data: Data
skip_version_check: bool = False
nex_version: int
client_version: int

ValidateAndRequestTicketResult

def __init__()
Creates a new ValidateAndRequestTicketResult instance. Required fields must be filled in manually.

The following fields are defined in this class:
pid: int
ticket: bytes
server_url: StationURL
server_time: DateTime
server_name: str
source_key: str