pub struct AuthApi;Expand description
AuthApi
Owns delegated-token helpers and root-signed role-attestation helpers.
Implementations§
Source§impl AuthApi
impl AuthApi
Sourcepub fn set_delegated_session_subject(
delegated_subject: Principal,
bootstrap_token: DelegatedToken,
requested_ttl_secs: Option<u64>,
) -> Result<(), Error>
pub fn set_delegated_session_subject( delegated_subject: Principal, bootstrap_token: DelegatedToken, requested_ttl_secs: Option<u64>, ) -> Result<(), Error>
Persist a temporary delegated session subject for the caller wallet.
Sourcepub fn clear_delegated_session()
pub fn clear_delegated_session()
Remove the caller’s delegated session subject.
Sourcepub fn delegated_session_subject() -> Option<Principal>
pub fn delegated_session_subject() -> Option<Principal>
Read the caller’s active delegated session subject, if configured.
Sourcepub fn prune_expired_delegated_sessions() -> usize
pub fn prune_expired_delegated_sessions() -> usize
Prune all currently expired delegated sessions.
Source§impl AuthApi
impl AuthApi
Sourcepub fn prepare_delegated_token(
request: DelegatedTokenPrepareRequest,
) -> Result<DelegatedTokenPrepareResponse, Error>
pub fn prepare_delegated_token( request: DelegatedTokenPrepareRequest, ) -> Result<DelegatedTokenPrepareResponse, Error>
Prepare a delegated token from the issuer-local active delegation proof.
Sourcepub fn get_delegated_token(
request: DelegatedTokenGetRequest,
) -> Result<DelegatedToken, Error>
pub fn get_delegated_token( request: DelegatedTokenGetRequest, ) -> Result<DelegatedToken, Error>
Retrieve a prepared delegated token with its issuer canister-signature proof.
Sourcepub fn install_active_delegation_proof(
request: InstallActiveDelegationProofRequest,
) -> Result<InstallActiveDelegationProofResponse, Error>
pub fn install_active_delegation_proof( request: InstallActiveDelegationProofRequest, ) -> Result<InstallActiveDelegationProofResponse, Error>
Install validated root-certified delegation material for issuer-local token issuance.
Sourcepub async fn prepare_delegation_proof(
request: DelegationProofIssueRequest,
) -> Result<DelegationProofPrepareResponse, Error>
pub async fn prepare_delegation_proof( request: DelegationProofIssueRequest, ) -> Result<DelegationProofPrepareResponse, Error>
Prepare a root delegation proof from root over RPC.
Sourcepub fn prepare_delegation_proof_root(
request: DelegationProofIssueRequest,
) -> Result<DelegationProofPrepareResponse, Error>
pub fn prepare_delegation_proof_root( request: DelegationProofIssueRequest, ) -> Result<DelegationProofPrepareResponse, Error>
Prepare a root-certified delegation proof from the local root update path.
Sourcepub fn get_delegation_proof_root(
request: DelegationProofGetRequest,
) -> Result<DelegationProof, Error>
pub fn get_delegation_proof_root( request: DelegationProofGetRequest, ) -> Result<DelegationProof, Error>
Retrieve a prepared self-contained delegation proof from the local root query path.
Sourcepub fn prepare_role_attestation_root(
request: RoleAttestationRequest,
) -> Result<RoleAttestationPrepareResponse, Error>
pub fn prepare_role_attestation_root( request: RoleAttestationRequest, ) -> Result<RoleAttestationPrepareResponse, Error>
Prepare a root-certified role attestation from the local root update path.
Sourcepub fn get_role_attestation_root(
request: RoleAttestationGetRequest,
) -> Result<SignedRoleAttestation, Error>
pub fn get_role_attestation_root( request: RoleAttestationGetRequest, ) -> Result<SignedRoleAttestation, Error>
Retrieve a prepared role attestation with its root canister-signature proof.
Sourcepub async fn verify_role_attestation(
attestation: &SignedRoleAttestation,
min_accepted_epoch: u64,
) -> Result<(), Error>
pub async fn verify_role_attestation( attestation: &SignedRoleAttestation, min_accepted_epoch: u64, ) -> Result<(), Error>
Verify a role attestation locally from its embedded root proof.