Namespace: go.std.encoding.pem

v1.0

Contents

• Summary
• Index
• Constants
• Variables
• Functions, Macros, and Special Forms
• Types

Summary

Provides a low-level interface to the encoding/pem package.

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

• *Block
• Block
• Decode
• Encode
• EncodeToMemory
• arrayOfBlock

Legend

Constant Variable Function Macro Special form Type GoVar Receiver/Method

Constants

Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

(None.)

Variables

(None.)

Functions, Macros, and Special Forms

• Decode

  Function v1.0

  (Decode data)
  

  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.
  
  Go input arguments: (data []byte)
  
  Go returns: (p *Block, rest []byte)
  
  Joker input arguments: [^arrayOfByte data]
  
  Joker returns: [^*Block p, ^arrayOfByte rest]

• Encode

  Function v1.0

  (Encode out b)
  

  Encode writes the PEM encoding of b to out.
  
  Go input arguments: (out io.Writer, b *Block)
  
  Go returns: error
  
  Joker input arguments: [^go.std.io/Writer out, ^*Block b]
  
  Joker returns: ^Error

• EncodeToMemory

  Function v1.0

  (EncodeToMemory b)
  

  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.
  
  Go input arguments: (b *Block)
  
  Go returns: []byte
  
  Joker input arguments: [^*Block b]
  
  Joker returns: ^arrayOfByte

Types

• *Block

  Concrete Type v1.0

  A Block represents a PEM encoded structure.
  
  The encoded form is:
  -----BEGIN Type-----
  Headers
  base64-encoded Bytes
  -----END Type-----
  where Headers is a possibly empty sequence of Key: Value lines.
  

• Block

  Concrete Type v1.0

  A Block represents a PEM encoded structure.
  
  The encoded form is:
  -----BEGIN Type-----
  Headers
  base64-encoded Bytes
  -----END Type-----
  where Headers is a possibly empty sequence of Key: Value lines.
  

• arrayOfBlock

  Concrete Type v1.0

  A Block represents a PEM encoded structure.
  
  The encoded form is:
  -----BEGIN Type-----
  Headers
  base64-encoded Bytes
  -----END Type-----
  where Headers is a possibly empty sequence of Key: Value lines.