Struct octorust::auth::JWTCredentials

pub struct JWTCredentials {
    pub app_id: u64,
    pub private_key: Vec<u8>,
    // some fields omitted
}

JSON Web Token authentication mechanism.

The GitHub client methods are all &self, but the dynamically generated JWT token changes regularly. The token is also a bit expensive to regenerate, so we do want to have a mutable cache.

We use a token inside a Mutex so we can have interior mutability even though JWTCredentials is not mutable.

Fields

app_id: u64

private_key: Vec<u8>

DER RSA key. Generate with openssl rsa -in private_rsa_key.pem -outform DER -out private_rsa_key.der

Implementations

impl JWTCredentials

pub fn new(app_id: u64, private_key: Vec<u8>) -> Result<JWTCredentials>

pub fn token(&self) -> String

Fetch a valid JWT token, regenerating it if necessary

Trait Implementations

impl Clone for JWTCredentials

fn clone(&self) -> JWTCredentials

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq<JWTCredentials> for JWTCredentials

fn eq(&self, other: &JWTCredentials) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.