Skip to main content

MachinePrivateKey

Struct MachinePrivateKey 

Source
pub struct MachinePrivateKey(/* private fields */);
Expand description

The X25519 private key of a unique piece of hardware running one or more Tailscale nodes.

Implementations§

Source§

impl MachinePrivateKey

Source

pub const KEY_LEN_BYTES: usize = 32

The length of this key type, in bytes.

Source

pub const KEY_LEN_HEX_STR: usize

The length of a hexidecimal string representation of this key, excluding the prefix and colon.

Source

pub const KEY_LEN_FULL_STR: usize

The length of a hexidecimal string representation of this key, including the prefix and colon.

Source

pub const KEY_PREFIX: &'static str = "privkey"

The prefix placed in front of string representations of this key type, such as “$key_prefix:abcd…”

Source

pub fn to_bytes(&self) -> [u8; 32]

Return this key as a u8 byte array.

Source§

impl MachinePrivateKey

Source

pub fn random() -> Self

Generate a new X25519 private key.

Source

pub fn public_key(&self) -> MachinePublicKey

Calculate the corresponding public key for this private key.

Takes &self (not self): deriving the public key must not consume — and thus drop/zeroize — the private key now that it is not Copy. Mirrors Go’s key.NodePrivate.Public() pointer receiver.

Trait Implementations§

Source§

impl Clone for MachinePrivateKey

Source§

fn clone(&self) -> MachinePrivateKey

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 MachinePrivateKey

Source§

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

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

impl Display for MachinePrivateKey

Source§

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

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

impl Drop for MachinePrivateKey

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Eq for MachinePrivateKey

Source§

impl From<&MachinePrivateKey> for StaticSecret

Source§

fn from(v: &MachinePrivateKey) -> Self

Converts to this type from the input type.
Source§

impl From<&MachinePrivateKey> for SecretKey

Source§

fn from(v: &MachinePrivateKey) -> Self

Converts to this type from the input type.
Source§

impl From<&MachinePrivateKey> for MachinePublicKey

Source§

fn from(v: &MachinePrivateKey) -> Self

Converts to this type from the input type.
Source§

impl From<MachinePrivateKey> for [u8; 32]

Source§

fn from(v: MachinePrivateKey) -> [u8; 32]

Converts to this type from the input type.
Source§

impl From<MachinePrivateKey> for StaticSecret

Source§

fn from(v: MachinePrivateKey) -> Self

Converts to this type from the input type.
Source§

impl From<MachinePrivateKey> for SecretKey

Source§

fn from(v: MachinePrivateKey) -> Self

Converts to this type from the input type.
Source§

impl From<MachinePrivateKey> for MachinePublicKey

Source§

fn from(v: MachinePrivateKey) -> Self

Converts to this type from the input type.
Source§

impl From<MachinePrivateKey> for MachineKeyPair

Source§

fn from(private: MachinePrivateKey) -> Self

Converts to this type from the input type.
Source§

impl From<[u8; 32]> for MachinePrivateKey

Source§

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

Converts to this type from the input type.
Source§

impl FromStr for MachinePrivateKey

Source§

type Err = ParseError

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for MachinePrivateKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for MachinePrivateKey

Source§

impl Zeroize for MachinePrivateKey

Source§

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.