Struct SecretKey 

pub struct SecretKey(pub SecretKey);

Secret key for peer identity and key sharing

A thin wrapper around Iroh’s SecretKey, representing the private part of an Ed25519 keypair. This key should be kept secret and securely stored (e.g., in the local config file).

Security Considerations

• Never share this key over the network
• Store encrypted or in a secure location (e.g., ~/.config/jax/secret.pem)
• Generate a new key for each peer instance

Examples

// Generate a new keypair
let secret_key = SecretKey::generate();
let public_key = secret_key.public();

// Persist to PEM format
let pem = secret_key.to_pem();
std::fs::write("secret.pem", pem)?;

// Load from PEM
let pem = std::fs::read_to_string("secret.pem")?;
let recovered = SecretKey::from_pem(&pem)?;

Tuple Fields

0: SecretKey

Implementations

impl SecretKey

pub fn from_hex(hex: &str) -> Result<Self, KeyError>

Parse a secret key from a hexadecimal string

Accepts both plain hex and “0x”-prefixed hex strings.

pub fn generate() -> Self

Generate a new random secret key using a cryptographically secure RNG

pub fn public(&self) -> PublicKey

Derive the public key from this secret key

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

Convert secret key to raw bytes

pub fn to_hex(&self) -> String

Convert secret key to hexadecimal string

pub fn to_pem(&self) -> String

Encode secret key in PEM format for secure storage

Returns a PEM-encoded string with tag “PRIVATE KEY”.

pub fn from_pem(pem_str: &str) -> Result<Self, KeyError>

Parse a secret key from PEM format

Errors

Returns an error if:

• The PEM string is malformed
• The PEM tag is not “PRIVATE KEY”
• The key size is incorrect

Methods from Deref<Target = SSecretKey>

pub fn public(&self) -> PublicKey

The public key of this SecretKey.

pub fn sign(&self, msg: &[u8]) -> Signature

Sign the given message and return a digital signature

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

Convert this to the bytes representing the secret part. The public part can always be recovered.

pub fn secret(&self) -> &SigningKey

Returns the SigningKey for this SecretKey.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Deref for SecretKey

type Target = SecretKey

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for SecretKey

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 SecretKey

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

Converts to this type from the input type.

impl Serialize for SecretKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.