hashrequest

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 18, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package hashrequest 对应 docs/v1/01-Hash请求频道.md。

本包实现 Hash 请求构造、严格解析、JCS 签名和完整校验。

Package hashrequest 实现 bsv8.hash.request.v1 公开频道。

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CheckDigestConflict

func CheckDigestConflict(existing, incoming encoding.SHA256Hash) error

CheckDigestConflict 在相同去重键对应不同摘要时返回 MESSAGE_ID_CONFLICT。

func Marshal

func Marshal(message SignedMessage) ([]byte, error)

Marshal 输出不含 channel 字段的规范 JCS 公开消息 JSON。

Types

type DeduplicationKey

type DeduplicationKey struct {
	// FromPublicKey 是消息发送者公钥。
	FromPublicKey encoding.PublicKey
	// MessageID 是消息编号。
	MessageID encoding.MessageID
}

DeduplicationKey 是公开消息的 (from_public_key, message_id) 去重键。

type HashRequestBody

type HashRequestBody struct {
	// Hash 是文件字节的 SHA-256 Hash。
	Hash encoding.SHA256Hash
	// Locators 是按建议尝试顺序排列的连接位置,至少一个。
	Locators []Locator
}

HashRequestBody 是公开 Hash 请求正文。

type Locator

type Locator struct {
	// Kind 是 locator 分支类型。
	Kind LocatorKind
	// Address 是标准 multiaddr;webrtc-sdp 分支不使用该字段。
	Address string
}

Locator 是按优先顺序排列的连接位置。 multiaddr 类型必须填写 Address;webrtc-sdp 类型必须保持 Address 为空。

func NewMultiaddrLocator

func NewMultiaddrLocator(address string) (Locator, error)

NewMultiaddrLocator 构造并校验标准 multiaddr locator。

func NewWebRTCSDPLocator

func NewWebRTCSDPLocator() Locator

NewWebRTCSDPLocator 构造无额外字段的 WebRTC locator。

type LocatorKind

type LocatorKind string

LocatorKind 是公开 Hash 请求的连接位置类型。

const (
	// LocatorMultiaddr 表示直接使用标准 multiaddr 建立后续连接。
	LocatorMultiaddr LocatorKind = "multiaddr"
	// LocatorWebRTCSDP 表示通过私密收件箱交换 WebRTC SDP。
	LocatorWebRTCSDP LocatorKind = "webrtc-sdp"
)

type SignedMessage

type SignedMessage struct {
	UnsignedMessage
	// Signature 是 bsv8.public-message.v1 唯一业务签名。
	Signature encoding.Signature
}

SignedMessage 是已经包含唯一业务签名的公开 Hash 请求。

func Sign

func Sign(message UnsignedMessage, privateKey encoding.PrivateKey) (SignedMessage, error)

Sign 校验待签名消息,并使用发送者长期私钥生成确定性 low-S 签名。

func (SignedMessage) SignedDigest

func (message SignedMessage) SignedDigest() encoding.SHA256Hash

SignedDigest 返回签名逻辑对象的稳定摘要;该值不含输入 JSON 的字段顺序。

type UnsignedMessage

type UnsignedMessage struct {
	// FromPublicKey 是请求者长期压缩公钥。
	FromPublicKey encoding.PublicKey
	// MessageID 是公开请求去重编号。
	MessageID encoding.MessageID
	// IssuedAtMs 是发布时间 Unix 毫秒。
	IssuedAtMs int64
	// ExpiresAtMs 是过期时间 Unix 毫秒。
	ExpiresAtMs int64
	// Body 是 Hash 与 locator 正文。
	Body HashRequestBody
}

UnsignedMessage 是待签名的公开 Hash 请求。

type VerifiedMessage

type VerifiedMessage struct {
	// contains filtered or unexported fields
}

VerifiedMessage 表示已完成结构、时间和签名验证的公开消息。

内部快照字段刻意不导出。Go 没有语言级 const struct,因此这里通过私有字段 加复制访问器保证“已验证”结果不会被调用方通过 slice/map/嵌套值改写。

func ParseAndVerify

func ParseAndVerify(channel string, input []byte) (VerifiedMessage, error)

ParseAndVerify 严格解析公开消息,允许输入字段顺序不同,再按 JCS 验签。

与通用公开消息一致:只校验结构时间(合法整数、issued < expires、有效期 不超过协议上限)和签名,不使用本地时钟判断过期或未来偏差。

func (VerifiedMessage) Body

func (message VerifiedMessage) Body() HashRequestBody

Body 返回 Hash 请求正文的深拷贝,包含 locators slice 的副本。

func (VerifiedMessage) DedupKey

func (message VerifiedMessage) DedupKey() DeduplicationKey

DedupKey 返回公开消息去重键。

func (VerifiedMessage) Digest

func (message VerifiedMessage) Digest() encoding.SHA256Hash

Digest 返回验签逻辑对象摘要值。

func (VerifiedMessage) ExpiresAtMs

func (message VerifiedMessage) ExpiresAtMs() int64

ExpiresAtMs 返回过期时间 Unix 毫秒。

func (VerifiedMessage) FromPublicKey

func (message VerifiedMessage) FromPublicKey() encoding.PublicKey

FromPublicKey 返回发送者公钥值。

func (VerifiedMessage) IsVerified

func (message VerifiedMessage) IsVerified() bool

IsVerified 返回该值是否由 ParseAndVerify 成功创建。

func (VerifiedMessage) IssuedAtMs

func (message VerifiedMessage) IssuedAtMs() int64

IssuedAtMs 返回发布时间 Unix 毫秒。

func (VerifiedMessage) MessageID

func (message VerifiedMessage) MessageID() encoding.MessageID

MessageID 返回消息编号值。

func (VerifiedMessage) Signature

func (message VerifiedMessage) Signature() encoding.Signature

Signature 返回签名值;Signature 内部字节通过 DER 方法复制。

func (VerifiedMessage) SignedMessage

func (message VerifiedMessage) SignedMessage() SignedMessage

SignedMessage 返回已验签消息的深拷贝;调用方修改返回值不会影响验证结果。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址