package pem

import "encoding/pem"

Package pem 实现 PEM 数据编码,该编码源自隐私增强邮件(Privacy Enhanced Mail)。如今 PEM 编码最常见的用途是 TLS 密钥和 证书。参见 RFC 1421。

Index

Examples

Functions

func Encode

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

Encode 将 b 的 PEM 编码写入 out。

Example
package main

import (
	"encoding/pem"
	"log"
	"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            // 类型,取自前言(即 "RSA PRIVATE KEY")。
	Headers map[string]string // 可选的头部。
	Bytes   []byte            // 内容的解码字节。通常是 DER 编码的 ASN.1 结构。
}

Block 表示一个 PEM 编码的结构。

编码形式为:

-----BEGIN Type-----
Headers
base64-encoded Bytes
-----END Type-----

其中 Block.Headers 是一个可能为空的 Key: Value 行序列。

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

Decode 会在输入中查找下一个 PEM 格式的块(证书、私钥 等)。它返回该块以及输入的剩余部分。如果 未找到 PEM 数据,则 p 为 nil,并会在 rest 中返回 整个输入。块必须从一行的开头开始,并在一行的末尾结束。

Example
package main

import (
	"crypto/x509"
	"encoding/pem"
	"fmt"
	"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"