XU XUv0.13.1
EN

#crypto/ecdh

导入方式: #crypto/ecdh

公开 API: 6 函数, 6 方法, 3 类型, 1 常量, 0 方法集

标准库包 `#crypto/ecdh`。

const X25519_KEY_SIZE

XuAPI
pub const X25519_KEY_SIZE = 32

用途

常量 X25519_KEY_SIZE,定义了相关的协议或算法配置参数。

struct Curve

XuAPI
pub struct Curve {
    pub name string
}

用途

承载 name 等属性的结构体。

公开字段

name string
名字

x25519

XuAPI
pub fn x25519() Curve

用途

执行 x25519 处理。

参数

无需传入参数。

返回值

Curve — 该类型的值

struct PublicKey

XuAPI
pub struct PublicKey {
    pub curve Curve
    pub raw string
}

用途

承载 curve、raw 等属性的结构体。

公开字段

curve Curve
字段(Curve)
raw string
字段(string)

(&PublicKey) bytes

XuAPI
pub fn (k &PublicKey) bytes() string

用途

&PublicKey 上的操作:返回已缓冲的字节串。

参数

k &PublicKey
本次调用使用的 PublicKey 实例;以只读借用传入,调用方仍持有实例。

返回值

string — 结果字符串

(&PublicKey) equal

XuAPI
pub fn (k &PublicKey) equal(other &PublicKey) bool

用途

&PublicKey 上的操作:判断两值是否相等。

参数

k &PublicKey
本次调用使用的 PublicKey 实例;以只读借用传入,调用方仍持有实例。
other &PublicKey
另一侧同类型值(只读借用,调用方仍持有原值;类型 &PublicKey)

返回值

bool — 是否成立

struct PrivateKey

XuAPI
pub struct PrivateKey {
    pub curve Curve
    pub raw string
    pub pub_key PublicKey
}

用途

承载 curve、raw、pub_key 等属性的结构体。

公开字段

curve Curve
字段(Curve)
raw string
字段(string)
pub_key PublicKey
字段(PublicKey)

(&PrivateKey) bytes

XuAPI
pub fn (k &PrivateKey) bytes() string

用途

&PrivateKey 上的操作:返回已缓冲的字节串。

参数

k &PrivateKey
本次调用使用的 PrivateKey 实例;以只读借用传入,调用方仍持有实例。

返回值

string — 结果字符串

(&PrivateKey) public_key

XuAPI
pub fn (k &PrivateKey) public_key() PublicKey

用途

&PrivateKey 上的操作:公钥键。

参数

k &PrivateKey
本次调用使用的 PrivateKey 实例;以只读借用传入,调用方仍持有实例。

返回值

PublicKey — 该类型的值

(&PrivateKey) equal

XuAPI
pub fn (k &PrivateKey) equal(other &PrivateKey) bool

用途

&PrivateKey 上的操作:判断两值是否相等。

参数

k &PrivateKey
本次调用使用的 PrivateKey 实例;以只读借用传入,调用方仍持有实例。
other &PrivateKey
另一侧同类型值(只读借用,调用方仍持有原值;类型 &PrivateKey)

返回值

bool — 是否成立

base_point

XuAPI
pub fn base_point() string

用途

执行 base point 操作。

参数

无需传入参数。

返回值

string — 结果字符串

scalar_mult

XuAPI
pub fn scalar_mult(scalar &string, point &string) string

用途

执行 scalar mult 操作。失败时抛出错误,调用方需处理或继续传播。

参数

scalar &string
scalar(只读借用,调用方仍持有原值;类型 &string)
point &string
point(只读借用,调用方仍持有原值;类型 &string)

返回值

string — 结果字符串

new_public_key

XuAPI
pub fn new_public_key(c Curve, key &string) PublicKey

用途

构造 public key。失败时抛出错误,调用方需处理或继续传播。

参数

c Curve
字节或字符码(Curve)
key &string
键(只读借用,调用方仍持有原值;类型 &string)

返回值

PublicKey — 该类型的值

new_private_key

XuAPI
pub fn new_private_key(c Curve, key &string) PrivateKey

用途

构造 private key。失败时抛出错误,调用方需处理或继续传播。

参数

c Curve
字节或字符码(Curve)
key &string
键(只读借用,调用方仍持有原值;类型 &string)

返回值

PrivateKey — 该类型的值

generate_key

XuAPI
pub fn generate_key(c Curve) PrivateKey

用途

生成键。失败时抛出错误,调用方需处理或继续传播。

参数

c Curve
字节或字符码(Curve)

返回值

PrivateKey — 该类型的值

(&PrivateKey) ecdh

XuAPI
pub fn (k &PrivateKey) ecdh(remote &PublicKey) string

用途

&PrivateKey 上的操作:基于椭圆曲线私钥与对端公钥计算共享密钥(ECDH 密钥协商)。失败时抛出错误,调用方需处理或继续传播。

参数

k &PrivateKey
本次调用使用的 PrivateKey 实例;以只读借用传入,调用方仍持有实例。
remote &PublicKey
remote(只读借用,调用方仍持有原值;类型 &PublicKey)

返回值

string — 结果字符串