pem

package standard library

go1.24.1 Latest Latest Go to latest Published: Mar 4, 2025 License: BSD-3-Clause Imports: 6 Imported by: 54,540

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

cs.opensource.google/go/go

Links

Report a Vulnerability

Documentation ¶

Overview ¶

Package pem implements the PEM data encoding, which originated in Privacy Enhanced Mail. The most common use of PEM encoding today is in TLS keys and certificates. See 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)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Encode ¶

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

Encode writes the PEM encoding of b to out.

Example ¶

Output:

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

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

func EncodeToMemory ¶

func EncodeToMemory(b *Block) []byte

EncodeToMemory returns the PEM encoding of b.

If b has invalid headers and cannot be encoded, EncodeToMemory returns nil. If it is important to report details about this error case, use Encode instead.

Types ¶

type Block ¶

type Block struct {
	Type    string            // The type, taken from the preamble (i.e. "RSA PRIVATE KEY").
	Headers map[string]string // Optional headers.
	Bytes   []byte            // The decoded bytes of the contents. Typically a DER encoded ASN.1 structure.
}

A Block represents a PEM encoded structure.

The encoded form is:

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

where [Block.Headers] is a possibly empty sequence of Key: Value lines.

func Decode ¶

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

Decode will find the next PEM formatted block (certificate, private key etc) in the input. It returns that block and the remainder of the input. If no PEM data is found, p is nil and the whole of the input is returned in rest.

Example ¶

Output:

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

Source Files ¶

View all Source files

pem.go

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