Struct rings_core::session::SessionSk

pub struct SessionSk { /* private fields */ }

SessionSk holds the Session and its session private key. To prove that the message was sent by the Account of Session, we need to attach session and the signature signed by sk to the payload.

SessionSk provide a session method to clone the session. SessionSk also provide sign method to sign a message.

To verify the session, use verify_self() method of Session. To verify a message, use verify(msg, sig) method of Session.

Implementations

impl SessionSk

pub fn new_with_seckey(key: &SecretKey) -> Result<Self>

Generate Session with private key. Only use it for unittest. To protect your private key, please use SessionSkBuilder to generate session.

pub fn session(&self) -> Session

Get session from SessionSk.

pub fn sign(&self, msg: &[u8]) -> Result<Vec<u8>>

Sign message with session.

pub fn account_did(&self) -> Did

Get account did from session.

pub fn dump(&self) -> Result<String>

Dump session_sk to string, allowing user to save it in a config file. It can be restored using SessionSk::from_str.

Trait Implementations

impl Clone for SessionSk

fn clone(&self) -> SessionSk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionSk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionSk

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for SessionSk

type Err = Error

The associated error which can be returned from parsing.

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

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

impl PartialEq for SessionSk

fn eq(&self, other: &SessionSk) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SessionSk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SessionSk

impl StructuralPartialEq for SessionSk