Skip to main content

GhostkeyResponse

Enum GhostkeyResponse 

Source
#[non_exhaustive]
pub enum GhostkeyResponse {
Show 22 variants ImportResult { fingerprint: String, notary_info: String, }, GhostKeyList { keys: Vec<GhostKeyInfo>, }, GhostKeyDetail { fingerprint: String, certificate_pem: String, label: Option<String>, notary_info: String, }, Certificate { fingerprint: String, certificate_pem: String, }, SignResult { scoped_payload: Vec<u8>, signature: Vec<u8>, certificate_pem: String, }, DefaultKeyResult { fingerprint: Option<String>, }, DefaultKeySet { fingerprint: String, }, VerifyResult { valid: bool, signer_fingerprint: Option<String>, notary_info: Option<String>, requestor: Option<SignatureRequestor>, message: Option<Vec<u8>>, }, Deleted { fingerprint: String, }, LabelSet { fingerprint: String, label: String, }, PermissionGranted { fingerprint: String, requestor: SignatureRequestor, }, PermissionRevoked { fingerprint: String, requestor: SignatureRequestor, }, PermissionList { fingerprint: String, requestors: Vec<SignatureRequestor>, }, ExportResult { fingerprint: String, certificate_pem: String, signing_key_pem: String, label: Option<String>, }, ExportAllResult { keys: Vec<ExportedGhostKey>, }, PermissionDenied { fingerprint: String, requestor: SignatureRequestor, }, AccessDenied { requestor: SignatureRequestor, }, NoIdentityAvailable, IdentityPresence { usable: usize, unusable: usize, }, BackedUpMarked { fingerprint: String, }, KeyNotFound { fingerprint: String, }, Error { message: String, },
}
Expand description

Responses from the ghostkey delegate.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

ImportResult

Fields

§fingerprint: String
§notary_info: String
§

GhostKeyList

Fields

§

GhostKeyDetail

Fields

§fingerprint: String
§certificate_pem: String
§notary_info: String
§

Certificate

Fields

§fingerprint: String
§certificate_pem: String
§

SignResult

Fields

§scoped_payload: Vec<u8>

CBOR-serialized ScopedPayload

§signature: Vec<u8>

Ed25519 signature over the scoped_payload bytes

§certificate_pem: String

The certificate PEM, so the verifier has the full chain

§

DefaultKeyResult

Fields

§fingerprint: Option<String>
§

DefaultKeySet

Fields

§fingerprint: String
§

VerifyResult

Fields

§valid: bool
§signer_fingerprint: Option<String>
§notary_info: Option<String>
§message: Option<Vec<u8>>
§

Deleted

Fields

§fingerprint: String
§

LabelSet

Fields

§fingerprint: String
§label: String
§

PermissionGranted

Fields

§fingerprint: String
§

PermissionRevoked

Fields

§fingerprint: String
§

PermissionList

Fields

§fingerprint: String
§

ExportResult

Fields

§fingerprint: String
§certificate_pem: String
§signing_key_pem: String
§

ExportAllResult

Fields

§

PermissionDenied

Fields

§fingerprint: String
§

AccessDenied

Permission denied for a request that didn’t name a specific fingerprint – today this means the user denied a RequestAnyAccess prompt. Distinct from PermissionDenied so callers don’t have to invent a placeholder fingerprint to pattern-match.

Fields

§

NoIdentityAvailable

The user has no ghostkeys. Apps should direct the user to freenet.org/ghostkey to purchase one.

It is NOT returned merely because the caller lacks permission — SignWithDefault prompts the user instead when the vault holds keys the caller has no grant on. So an app can treat this as “offer to buy one” without first checking whether it was really a permissions problem.

Precisely, it means no identity is available to sign with: either the vault is empty, or every identity in it has lost its signing key. Use HasIdentity to tell those apart — its unusable count is non-zero in the second case, which is worth a different message, since buying another key is not what that user needs.

§

IdentityPresence

Reply to HasIdentity. Counts only — no fingerprints, labels or tiers.

Fields

§usable: usize

Identities that can actually sign: certificate AND signing key both present.

§unusable: usize

Identities whose certificate loads but whose signing key is gone. These still appear in ListGhostKeys, which never checks for the signing key, so without this count a half-lost identity looks perfectly healthy right up until it fails to sign.

§

BackedUpMarked

Confirms MarkBackedUp.

Fields

§fingerprint: String
§

KeyNotFound

The requested ghostkey fingerprint was not found.

Fields

§fingerprint: String
§

Error

Generic error for unexpected failures.

Fields

§message: String

Trait Implementations§

Source§

impl Clone for GhostkeyResponse

Source§

fn clone(&self) -> GhostkeyResponse

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GhostkeyResponse

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for GhostkeyResponse

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for GhostkeyResponse

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more