Struct AuthenticatedPeer 

pub struct AuthenticatedPeer {
    pub peer_id: String,
    pub role: TokenRole,
    pub parties: Vec<PartyRef>,
    pub version: VersionNumber,
}

Available on crate feature server only.

The party a request was authenticated as.

Fields

peer_id: String

A stable identifier for the platform, for logging and for looking up its state.

role: TokenRole

Which handshake token this is, which decides what it may address.

parties: Vec<PartyRef>

The parties this platform speaks for, from the roles of its credentials.

version: VersionNumber

The OCPI version the connection was registered with.

Implementations

impl AuthenticatedPeer

pub fn owns(&self, party: &PartyRef) -> bool

Whether this platform speaks for party.

This is what decides whether a client-owned-object URL is theirs to write to.

pub fn check_scope(&self, module: &ModuleId) -> Result<(), OcpiError>

Checks that this token may address module.

When a server receives a request with a valid CREDENTIALS_TOKEN_A, on another module than credentials or versions, the server SHALL respond with an HTTP 401 - Unauthorized status code.

Errors

Returns OcpiError::TokenAOutOfScope, which maps to HTTP 401.

Spec: 2.3.0 §transport_and_format_authorization_header

pub fn check_ownership(&self, owner: &PartyRef) -> Result<(), OcpiError>

Checks that this platform may write to a client-owned object under owner.

When a client tries to access an object with a URL that has a different country_code and/or party_id than one of the CredentialsRoles given during the credentials handshake, it is allowed to respond with an HTTP 404 status code, this way blocking client access to objects that do not belong to them.

A 404 rather than a 403 is deliberate: it does not reveal whether the object exists.

Errors

Returns OcpiError::NotFound, which maps to HTTP 404.

Spec: 2.3.0 §transport_and_format_errors

Trait Implementations

impl Clone for AuthenticatedPeer

fn clone(&self) -> AuthenticatedPeer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthenticatedPeer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AuthenticatedPeer

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AuthenticatedPeer