Struct firestore_db_and_auth::credentials::Credentials

pub struct Credentials {
    pub project_id: String,
    pub private_key_id: String,
    pub client_email: String,
    pub client_id: String,
    pub api_key: String,
    pub pub_key: BTreeMap<String, RSAKeyParameters>,
    pub private_key_der: Vec<u8>,
    // some fields omitted
}

Service account credentials

Especially the service account email is required to retrieve the public java web key set (jwks) for verifying Google Firestore tokens.

The api_key is necessary for interacting with the Firestore REST API.

Internals:

The private key is used for signing JWTs (javascript web token). A signed jwt, encoded as a base64 string, can be exchanged into a refresh and access token.

Fields

project_id: String

private_key_id: String

client_email: String

client_id: String

api_key: String

pub_key: BTreeMap<String, RSAKeyParameters>

This is not defined in the json file and computed

private_key_der: Vec<u8>

This is not defined in the json file and computed

Methods

impl Credentials

pub fn public_key(&self, kid: &str) -> Option<&RSAKeyParameters>

Find the key in the set that matches the given key id, if any.

pub fn create_rsa_key_pair(&self) -> Result<RsaKeyPair>

Creates a ring RsaKeyPair out of the private key of this credentials object

pub fn from_file(credential_file: &str) -> Result<Self>

Create a Credentials object by reading and parsing a google-service-account json file.

The public keys to verify generated tokens will be downloaded, for the given service account as well as for "securetoken@system.gserviceaccount.com". Do not use this method if this is not desired, see Credentials::add_jwks_public_keys for an alternative.

pub fn add_jwks_public_keys(&mut self, jwkset: JWKSetDTO)

Add a jwks file to verify Google access tokens.

Example:

use firestore_db_and_auth::credentials::Credentials;

let mut c : Credentials = serde_json::from_str(include_str!("../firebase-service-account.json")).unwrap();
c.add_jwks_public_keys(serde_json::from_str(include_str!("../service-account-for-tests.jwks")).unwrap());
c.compute_missing_fields().unwrap();

pub fn compute_missing_fields(&mut self) -> Result<()>

This method will compute an alternative representation of the private key and must be called before using any of the session methods. This is automatically invoked if you use Credentials::from_file.

If you haven't called Credentials::add_jwks_public_keys to manually add public keys, this method will download one for your google service account and one for the oauth related securetoken@system.gserviceaccount.com service account.

Trait Implementations

impl Default for Credentials

fn default() -> Credentials

Returns the "default value" for a type.

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a copy of the value.

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

Performs copy-assignment from source.

impl FromStr for Credentials

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for Credentials

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Credentials

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.