Documentation ¶
Index ¶
- Variables
- func EncodeExitCompleted(ctx context.Context, exitCompleted *pb.ExitCompleted) (_ []byte, err error)
- func EncodeExitFailed(ctx context.Context, exitFailed *pb.ExitFailed) (_ []byte, err error)
- func EncodeOrder(ctx context.Context, order *pb.Order) (_ []byte, err error)
- func EncodeOrderLimit(ctx context.Context, limit *pb.OrderLimit) (_ []byte, err error)
- func EncodePieceHash(ctx context.Context, hash *pb.PieceHash) (_ []byte, err error)
- func EncodeSegmentID(ctx context.Context, segmentID *pb.SatSegmentID) (_ []byte, err error)
- func EncodeStreamID(ctx context.Context, streamID *pb.SatStreamID) (_ []byte, err error)
- func EncodeVoucher(ctx context.Context, voucher *pb.Voucher) (_ []byte, err error)
- func SignExitCompleted(ctx context.Context, signer Signer, unsigned *pb.ExitCompleted) (_ *pb.ExitCompleted, err error)
- func SignExitFailed(ctx context.Context, signer Signer, unsigned *pb.ExitFailed) (_ *pb.ExitFailed, err error)
- func SignOrderLimit(ctx context.Context, satellite Signer, unsigned *pb.OrderLimit) (_ *pb.OrderLimit, err error)
- func SignPieceHash(ctx context.Context, signer Signer, unsigned *pb.PieceHash) (_ *pb.PieceHash, err error)
- func SignSegmentID(ctx context.Context, signer Signer, unsigned *pb.SatSegmentID) (_ *pb.SatSegmentID, err error)
- func SignStreamID(ctx context.Context, signer Signer, unsigned *pb.SatStreamID) (_ *pb.SatStreamID, err error)
- func SignUplinkOrder(ctx context.Context, privateKey storj.PiecePrivateKey, unsigned *pb.Order) (_ *pb.Order, err error)
- func SignUplinkPieceHash(ctx context.Context, privateKey storj.PiecePrivateKey, unsigned *pb.PieceHash) (_ *pb.PieceHash, err error)
- func SignVoucher(ctx context.Context, signer Signer, unsigned *pb.Voucher) (_ *pb.Voucher, err error)
- func VerifyExitCompleted(ctx context.Context, satellite Signee, signed *pb.ExitCompleted) (err error)
- func VerifyExitFailed(ctx context.Context, satellite Signee, signed *pb.ExitFailed) (err error)
- func VerifyOrderLimitSignature(ctx context.Context, satellite Signee, signed *pb.OrderLimit) (err error)
- func VerifyOrderSignature(ctx context.Context, uplink Signee, signed *pb.Order) (err error)
- func VerifyPieceHashSignature(ctx context.Context, signee Signee, signed *pb.PieceHash) (err error)
- func VerifySegmentID(ctx context.Context, satellite Signee, signed *pb.SatSegmentID) (err error)
- func VerifyStreamID(ctx context.Context, satellite Signee, signed *pb.SatStreamID) (err error)
- func VerifyUplinkOrderSignature(ctx context.Context, publicKey storj.PiecePublicKey, signed *pb.Order) (err error)
- func VerifyUplinkPieceHashSignature(ctx context.Context, publicKey storj.PiecePublicKey, signed *pb.PieceHash) (err error)
- func VerifyVoucher(ctx context.Context, satellite Signee, signed *pb.Voucher) (err error)
- type PrivateKey
- type PublicKey
- type Signee
- type Signer
Constants ¶
This section is empty.
Variables ¶
var Error = errs.Class("signing")
Error is the default error class for signing package.
Functions ¶
func EncodeExitCompleted ¶ added in v0.25.0
func EncodeExitCompleted(ctx context.Context, exitCompleted *pb.ExitCompleted) (_ []byte, err error)
EncodeExitCompleted encodes ExitCompleted into bytes for signing.
func EncodeExitFailed ¶ added in v0.25.0
EncodeExitFailed encodes ExitFailed into bytes for signing.
func EncodeOrder ¶
EncodeOrder encodes order into bytes for signing. Removes signature from serialized order.
func EncodeOrderLimit ¶
EncodeOrderLimit encodes order limit into bytes for signing. Removes signature from serialized limit.
func EncodePieceHash ¶
EncodePieceHash encodes piece hash into bytes for signing. Removes signature from serialized hash.
func EncodeSegmentID ¶
EncodeSegmentID encodes segment ID into bytes for signing.
func EncodeStreamID ¶
EncodeStreamID encodes stream ID into bytes for signing.
func EncodeVoucher ¶
EncodeVoucher encodes voucher into bytes for signing.
func SignExitCompleted ¶ added in v0.25.0
func SignExitCompleted(ctx context.Context, signer Signer, unsigned *pb.ExitCompleted) (_ *pb.ExitCompleted, err error)
SignExitCompleted signs the ExitCompleted using the specified signer Signer is a satellite
func SignExitFailed ¶ added in v0.25.0
func SignExitFailed(ctx context.Context, signer Signer, unsigned *pb.ExitFailed) (_ *pb.ExitFailed, err error)
SignExitFailed signs the ExitFailed using the specified signer Signer is a satellite
func SignOrderLimit ¶
func SignOrderLimit(ctx context.Context, satellite Signer, unsigned *pb.OrderLimit) (_ *pb.OrderLimit, err error)
SignOrderLimit signs the order limit using the specified signer. Signer is a satellite.
func SignPieceHash ¶
func SignPieceHash(ctx context.Context, signer Signer, unsigned *pb.PieceHash) (_ *pb.PieceHash, err error)
SignPieceHash signs the piece hash using the specified signer. Signer is either uplink or storage node.
func SignSegmentID ¶
func SignSegmentID(ctx context.Context, signer Signer, unsigned *pb.SatSegmentID) (_ *pb.SatSegmentID, err error)
SignSegmentID signs the segment ID using the specified signer Signer is a satellite
func SignStreamID ¶
func SignStreamID(ctx context.Context, signer Signer, unsigned *pb.SatStreamID) (_ *pb.SatStreamID, err error)
SignStreamID signs the stream ID using the specified signer Signer is a satellite
func SignUplinkOrder ¶
func SignUplinkOrder(ctx context.Context, privateKey storj.PiecePrivateKey, unsigned *pb.Order) (_ *pb.Order, err error)
SignUplinkOrder signs the order using the specified signer. Signer is an uplink.
func SignUplinkPieceHash ¶
func SignUplinkPieceHash(ctx context.Context, privateKey storj.PiecePrivateKey, unsigned *pb.PieceHash) (_ *pb.PieceHash, err error)
SignUplinkPieceHash signs the piece hash using the specified signer. Signer is either uplink or storage node.
func SignVoucher ¶
func SignVoucher(ctx context.Context, signer Signer, unsigned *pb.Voucher) (_ *pb.Voucher, err error)
SignVoucher signs the voucher using the specified signer Signer is a satellite
func VerifyExitCompleted ¶ added in v0.25.0
func VerifyExitCompleted(ctx context.Context, satellite Signee, signed *pb.ExitCompleted) (err error)
VerifyExitCompleted verifies that the signature inside ExitCompleted belongs to the satellite
func VerifyExitFailed ¶ added in v0.25.0
VerifyExitFailed verifies that the signature inside ExitFailed belongs to the satellite
func VerifyOrderLimitSignature ¶
func VerifyOrderLimitSignature(ctx context.Context, satellite Signee, signed *pb.OrderLimit) (err error)
VerifyOrderLimitSignature verifies that the signature inside order limit is valid and belongs to the satellite.
func VerifyOrderSignature ¶
VerifyOrderSignature verifies that the signature inside order is valid and belongs to the uplink.
func VerifyPieceHashSignature ¶
VerifyPieceHashSignature verifies that the signature inside piece hash is valid and belongs to the signer, which is either uplink or storage node.
func VerifySegmentID ¶
VerifySegmentID verifies that the signature inside segment ID belongs to the satellite
func VerifyStreamID ¶
VerifyStreamID verifies that the signature inside stream ID belongs to the satellite
func VerifyUplinkOrderSignature ¶
func VerifyUplinkOrderSignature(ctx context.Context, publicKey storj.PiecePublicKey, signed *pb.Order) (err error)
VerifyUplinkOrderSignature verifies that the signature inside order is valid and belongs to the uplink.
func VerifyUplinkPieceHashSignature ¶
func VerifyUplinkPieceHashSignature(ctx context.Context, publicKey storj.PiecePublicKey, signed *pb.PieceHash) (err error)
VerifyUplinkPieceHashSignature verifies that the signature inside piece hash is valid and belongs to the signer, which is either uplink or storage node.
Types ¶
type PrivateKey ¶
type PrivateKey struct { Self storj.NodeID Key crypto.PrivateKey }
PrivateKey implements a signer and signee using a crypto.PrivateKey.
func (*PrivateKey) HashAndSign ¶
HashAndSign hashes the data and signs with the used key.
func (*PrivateKey) HashAndVerifySignature ¶
func (private *PrivateKey) HashAndVerifySignature(ctx context.Context, data, signature []byte) (err error)
HashAndVerifySignature hashes the data and verifies that the signature belongs to the PrivateKey.
func (*PrivateKey) ID ¶
func (private *PrivateKey) ID() storj.NodeID
ID returns node id associated with PrivateKey.
type PublicKey ¶
PublicKey implements a signee using crypto.PublicKey.
type Signee ¶
type Signee interface { ID() storj.NodeID HashAndVerifySignature(ctx context.Context, data, signature []byte) error }
Signee is able to verify that the data signature belongs to the signee.
func SigneeFromPeerIdentity ¶
func SigneeFromPeerIdentity(identity *identity.PeerIdentity) Signee
SigneeFromPeerIdentity returns signee based on peer identity.
type Signer ¶
type Signer interface { ID() storj.NodeID HashAndSign(ctx context.Context, data []byte) ([]byte, error) HashAndVerifySignature(ctx context.Context, data, signature []byte) error }
Signer is able to sign data and verify own signature belongs.
func SignerFromFullIdentity ¶
func SignerFromFullIdentity(identity *identity.FullIdentity) Signer
SignerFromFullIdentity returns signer based on full identity.