crypto

Documentation

Overview

cryptoパッケージは一般的な暗号定数を収集します。

Index

• func RegisterHash(h Hash, f func() hash.Hash)
• func SignMessage(signer Signer, rand io.Reader, msg []byte, opts SignerOpts) (signature []byte, err error)
• type Decrypter
• type DecrypterOpts
• type Hash
  • func (h Hash) Available() bool
  • func (h Hash) HashFunc() Hash
  • func (h Hash) New() hash.Hash
  • func (h Hash) Size() int
  • func (h Hash) String() string
• type MessageSigner
• type PrivateKey
• type PublicKey
• type Signer
• type SignerOpts

Functions

func RegisterHash

func RegisterHash(h Hash, f func() hash.Hash)

RegisterHash は与えられたハッシュ関数の新しいインスタンスを返す関数を登録します。 これはハッシュ関数を実装するパッケージの init 関数から呼び出されることを意図しています。

func SignMessage

func SignMessage(signer Signer, rand io.Reader, msg []byte, opts SignerOpts) (signature []byte, err error)

SignMessageはsignerでmsgに署名します。signerが MessageSigner を実装している場合、 [MessageSigner.SignMessage] が直接呼び出されます。そうでなければ、msgは opts.HashFunc()でハッシュ化され、[Signer.Sign] で署名されます。

Types

type Decrypter

type Decrypter interface {
	Public() PublicKey

	Decrypt(rand io.Reader, msg []byte, opts DecrypterOpts) (plaintext []byte, err error)
}

Decrypterは、非対称復号化操作に使用できる不透明な秘密鍵のインターフェースです。例えば、ハードウェアモジュールに保管されるRSA鍵があります。

type DecrypterOpts

type DecrypterOpts any

type Hash

type Hash uint

Hashは別のパッケージで実装されている暗号ハッシュ関数を識別します。

const (
	MD4 Hash = 1 + iota
	MD5
	SHA1
	SHA224
	SHA256
	SHA384
	SHA512
	MD5SHA1
	RIPEMD160
	SHA3_224
	SHA3_256
	SHA3_384
	SHA3_512
	SHA512_224
	SHA512_256
	BLAKE2s_256
	BLAKE2b_256
	BLAKE2b_384
	BLAKE2b_512
)

func (Hash) Available

func (h Hash) Available() bool

Availableは、与えられたハッシュ関数がバイナリにリンクされているかどうかを示します。

func (Hash) HashFunc

func (h Hash) HashFunc() Hash

HashFunc は単に h の値を返すだけであり、 Hash が SignerOpts を実装することを保証します。

func (Hash) New

func (h Hash) New() hash.Hash

Newは指定されたハッシュ関数を計算する新しいhash.Hashを返します。ハッシュ関数がバイナリにリンクされていない場合、Newはパニックを発生させます。

func (Hash) Size

func (h Hash) Size() int

Sizeは与えられたハッシュ関数から生成されるダイジェストの長さ（バイト単位）を返します。 この関数は、対象のハッシュ関数がプログラムにリンクされている必要はありません。

func (Hash) String

func (h Hash) String() string

type MessageSigner

type MessageSigner interface {
	Signer
	SignMessage(rand io.Reader, msg []byte, opts SignerOpts) (signature []byte, err error)
}

MessageSignerは、呼び出し元によってメッセージが事前にハッシュ化されていない 署名操作に使用できる不透明な秘密鍵のインターフェースです。 これは、Signerを受け入れるAPIに渡すことができるように、Signerインターフェースの スーパーセットであり、これらのAPIはインターフェースのアップグレードを試行する場合があります。

MessageSigner.SignMessageとMessageSigner.Signは、同じoptsが与えられた場合、 同じ結果を生成する必要があります。特に、MessageSigner.SignMessageは、 Signerも事前にハッシュ化されていないメッセージを受け入れる場合にのみ、 ゼロのopts.HashFuncを受け入れる必要があります。

事前にハッシュ化されたSign APIを提供しない実装では、 常にエラーを返すことでSigner.Signを実装する必要があります。

type PrivateKey

type PrivateKey any

PrivateKeyは不特定のアルゴリズムを使用して秘密鍵を表します。

この型は、後方互換性のために空のインターフェースとして定義されていますが、 標準ライブラリのすべての秘密鍵タイプは以下のインターフェースを実装します。

interface{
    Public() crypto.PublicKey
    Equal(x crypto.PrivateKey) bool
}

また、 Signer や Decrypter などの特定の目的のインターフェースも実装しており、 アプリケーション内で型の安全性を向上させるために使用できます。

type PublicKey

type PublicKey any

PublicKeyは未指定のアルゴリズムを使用して公開鍵を表します。

このタイプは、後方互換性のための空のインターフェースですが、 標準ライブラリのすべての公開鍵タイプは、以下のインターフェースを実装しています。

interface{
    Equal(x crypto.PublicKey) bool
}

アプリケーション内での型安全性向上のために使用することができます。

type Signer

type Signer interface {
	Public() PublicKey

	Sign(rand io.Reader, digest []byte, opts SignerOpts) (signature []byte, err error)
}

Signerは、署名操作に使用される不透明な秘密鍵のインターフェースです。たとえば、ハードウェアモジュールに保存されているRSA鍵などがあります。

type SignerOpts

type SignerOpts interface {
	HashFunc() Hash
}

SignerOptsは Signer での署名のためのオプションを含みます。