pem

Documentation

Overview

パッケージpemは、プライバシー拡張メールで起源を持つPEMデータのエンコーディングを実装しています。現在最も一般的なPEMエンコーディングの使用法は、TLSキーと証明書です。RFC 1421を参照してください。

Index

• func Encode(out io.Writer, b *Block) error
• func EncodeToMemory(b *Block) []byte
• type Block
  • func Decode(data []byte) (p *Block, rest []byte)

Examples

• Decode
• Encode

Functions

func Encode

func Encode(out io.Writer, b *Block) error

Encodeは、bのPEMエンコーディングをoutに書き込みます。

Example

package main

import (
	"github.com/shogo82148/std/encoding/pem"
	"github.com/shogo82148/std/log"
	"github.com/shogo82148/std/os"
)

func main() {
	block := &pem.Block{
		Type: "MESSAGE",
		Headers: map[string]string{
			"Animal": "Gopher",
		},
		Bytes: []byte("test"),
	}

	if err := pem.Encode(os.Stdout, block); err != nil {
		log.Fatal(err)
	}
}

Output:
-----BEGIN MESSAGE-----
Animal: Gopher

dGVzdA==
-----END MESSAGE-----

func EncodeToMemory

func EncodeToMemory(b *Block) []byte

EncodeToMemoryはbのPEMエンコーディングを返します。

bに無効なヘッダーがある場合や、エンコードできない場合、 EncodeToMemoryはnilを返します。このエラーケースの詳細を報告することが重要な場合は、 代わりにEncodeを使用してください。

Types

type Block

type Block struct {
	Type    string
	Headers map[string]string
	Bytes   []byte
}

BlockはPEMエンコードされた構造体を表します。

エンコードされた形式は次のようになります：

-----BEGIN Type----- Headers Base64エンコードされたバイト -----END Type-----

Headersはキー: 値の行からなる、可能性のある空のシーケンスです。

func Decode

func Decode(data []byte) (p *Block, rest []byte)

Decodeは入力内で次のPEM形式のブロック（証明書、秘密鍵など）を見つけます。それはそのブロックと入力の残り部分を返します。PEMデータが見つからない場合は、pがnilであり、入力全体がrestとして返されます。

Example

package main

import (
	"github.com/shogo82148/std/crypto/x509"
	"github.com/shogo82148/std/encoding/pem"
	"github.com/shogo82148/std/fmt"
	"github.com/shogo82148/std/log"
)

func main() {
	var pubPEMData = []byte(`
-----BEGIN PUBLIC KEY-----
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAlRuRnThUjU8/prwYxbty
WPT9pURI3lbsKMiB6Fn/VHOKE13p4D8xgOCADpdRagdT6n4etr9atzDKUSvpMtR3
CP5noNc97WiNCggBjVWhs7szEe8ugyqF23XwpHQ6uV1LKH50m92MbOWfCtjU9p/x
qhNpQQ1AZhqNy5Gevap5k8XzRmjSldNAFZMY7Yv3Gi+nyCwGwpVtBUwhuLzgNFK/
yDtw2WcWmUU7NuC8Q6MWvPebxVtCfVp/iQU6q60yyt6aGOBkhAX0LpKAEhKidixY
nP9PNVBvxgu3XZ4P36gZV6+ummKdBVnc3NqwBLu5+CcdRdusmHPHd5pHf4/38Z3/
6qU2a/fPvWzceVTEgZ47QjFMTCTmCwNt29cvi7zZeQzjtwQgn4ipN9NibRH/Ax/q
TbIzHfrJ1xa2RteWSdFjwtxi9C20HUkjXSeI4YlzQMH0fPX6KCE7aVePTOnB69I/
a9/q96DiXZajwlpq3wFctrs1oXqBp5DVrCIj8hU2wNgB7LtQ1mCtsYz//heai0K9
PhE4X6hiE0YmeAZjR0uHl8M/5aW9xCoJ72+12kKpWAa0SFRWLy6FejNYCYpkupVJ
yecLk/4L1W0l6jQQZnWErXZYe0PNFcmwGXy1Rep83kfBRNKRy5tvocalLlwXLdUk
AIU+2GKjyT3iMuzZxxFxPFMCAwEAAQ==
-----END PUBLIC KEY-----
and some more`)

	block, rest := pem.Decode(pubPEMData)
	if block == nil || block.Type != "PUBLIC KEY" {
		log.Fatal("failed to decode PEM block containing public key")
	}

	pub, err := x509.ParsePKIXPublicKey(block.Bytes)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Printf("Got a %T, with remaining data: %q", pub, rest)
}

Output:
Got a *rsa.PublicKey, with remaining data: "and some more"