Struct Cookie

pub struct Cookie(/* private fields */);

represents an RPC authentication cookie

a cookie file is created each time neptune-core is started.

local (same-device) RPC clients with read access to the cookie file can read it and provide the cookie as an auth Token when calling RPC methods.

The cookie serves a couple purposes:

1. proves to neptune-core that the client is on the same device and has read access for files written by neptune-core.
2. enables automated authentication without requiring user to manually set a password somewhere.

Implementations

impl Cookie

pub async fn try_load(data_dir: &DataDirectory) -> Result<Self, CookieFileError>

try loading cookie from a file

pub async fn try_new(data_dir: &DataDirectory) -> Result<Self, CookieFileError>

try creating a new cookie file

This will overwrite any existing cookie file.

The overwrite is performed via rename, so should be an atomic operation on most filesystems.

note: will create missing directories in path if necessary.

pub fn auth(&self, valid: &Self) -> Result<(), AuthError>

authenticate against a known valid cookie

pub fn cookie_file_path(data_dir: &DataDirectory) -> PathBuf

get cookie file path

Trait Implementations

impl Clone for Cookie

fn clone(&self) -> Cookie

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cookie

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cookie

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<[u8; 32]> for Cookie

fn from(bytes: [u8; 32]) -> Self

Converts to this type from the input type.

impl From<Cookie> for Token

fn from(c: Cookie) -> Self

Converts to this type from the input type.

impl Hash for Cookie

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Cookie

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Cookie

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Cookie

impl Eq for Cookie

impl StructuralPartialEq for Cookie