signature_header

README

ActivityPub Signature header

by Cloudmate

---

Install

go get -u github.com/cloudmatelabs/go-activitypub-signature-header

Introduce

This library is generate Signature header for the connect with ActivityPub federations.
And verify the Signature header.

Usage

Sign Signature header

import (
  "crypto"
  "net/url"

  "github.com/go-resty/resty/v2"
  signature_header "github.com/cloudmatelabs/go-activitypub-signature-header"
)

requestURL, _ := url.Parse("https://yodangang.express/users/9iffvxhojp/inbox")
message := []byte(`{
  "@context": "https://www.w3.org/ns/activitystreams",
  "id": "https://snippet.social/@juunini",
  "type": "Follow",
  "actor": "https://snippet.social/@juunini",
  "object": "https://yodangang.express/users/9iffvxhojp"
}`)

headers, err := signature_header.Generate(signature_header.GenerateInput{
  PrivateKeyBytes: []byte("-----BEGIN RSA PRIVATE KEY-----..."),
  // Algorithm:       crypto.SHA256, // optional. if not set, default is crypto.SHA256
  Host:            requestURL.Host,
  Path:            requestURL.Path,
  Body:            message,
  KeyID:           "https://snippet.social/@juunini#main-key",
})
if err != nil {
  // handle error
}

resty.New().R().
  SetBody(message).
  SetHeader("Date", headers.Date).
  SetHeader("Digest", headers.Digest).
  SetHeader("Host", headers.Host).
  SetHeader("Signature", headers.Signature).
  SetHeader("Content-Type", "application/activity+json").
  Post(requestURL.String())

Verify Signature header

import (
  signature_header "github.com/cloudmatelabs/go-activitypub-signature-header"
)

verifier := signature_header.Verifier{
  Method: "POST",
  URL: "https://snippet.social/@juunini/inbox",
  Headers: map[string]string{
    "Signature": "...",
    "Host": "...",
    "Date": "...",
    "Digest": "...",
    "Authorization": "...",
    "...": "...",
  },
}

// Recommended
err := verifier.VerifyWithPublicKey(publicKey)
err := verifier.VerifyWithPublicKeyStr(publicKeyStr)

// You can use, but not recommended
err := verifier.VerifyWithActor("https://yodangang.express/@juunini")
err := verifier.VerifyWithBody([]byte("{...}"))

Parse Signature header

import (
  signature_header "github.com/cloudmatelabs/go-activitypub-signature-header"
)

// map[string]string
params := signature_header.ParseSignature(signature)
// or given Signature authorization header
// params := signature_header.ParseSignature(authorization)

params["keyId"]
params["algorithm"]
params["headers"]
params["signature"]

License

MIT

But, this library use httpsig.
httpsig is licensed under the BSD 3-Clause License

Documentation

Index

• func Date() string
• func Digest(hash crypto.Hash, message []byte) string
• func GenerateKey(bits int) (privateKey *rsa.PrivateKey, privateKeyBytes []byte, publicKeyBytes []byte)
• func ParseSignature(signatureStr string) map[string]string
• func PrivateKeyFromBytes(privateKeyBytes []byte) (*rsa.PrivateKey, error)
• type GenerateInput
• type GenerateOutput
  • func Generate(input GenerateInput) (*GenerateOutput, error)
• type Signature
  • func (s Signature) String() (string, error)
• type Verifier
  • func (v *Verifier) VerifyWithActor(actor string) error
  • func (v *Verifier) VerifyWithBody(body []byte) error
  • func (v *Verifier) VerifyWithPublicKey(publicKey crypto.PublicKey) error
  • func (v *Verifier) VerifyWithPublicKeyStr(publicKeyStr string) error

Functions

func Date

func Date() string

func Digest

func Digest(hash crypto.Hash, message []byte) string

Example: signature_header.Digest(crypto.SHA256, []byte(`{"@context": [...], ...}`))

Output: SHA-256=7Uq...Q==

func GenerateKey

func GenerateKey(bits int) (privateKey *rsa.PrivateKey, privateKeyBytes []byte, publicKeyBytes []byte)

func ParseSignature

func ParseSignature(signatureStr string) map[string]string

func PrivateKeyFromBytes

func PrivateKeyFromBytes(privateKeyBytes []byte) (*rsa.PrivateKey, error)

Types

type GenerateInput

type GenerateInput struct {
	PrivateKeyBytes []byte
	Algorithm       crypto.Hash
	Host            string
	Path            string
	Body            []byte
	KeyID           string
}

Example:

signature_header.GenerateInput{
	PrivateKeyBytes: []byte("-----BEGIN RSA PRIVATE KEY-----..."),
	Algorithm: crypto.SHA256,
	Host: "example.com",
	Path: "/inbox",
	KeyID: "https://snippet.social/@juunini#main-key",
}

type GenerateOutput

type GenerateOutput struct {
	Date      string
	Host      string
	Digest    string
	Signature string
}

func Generate

func Generate(input GenerateInput) (*GenerateOutput, error)

Example:

headers, err := signature_header.Generate(signature_header.GenerateInput{
	PrivateKeyBytes: []byte("-----BEGIN RSA PRIVATE KEY-----..."),
	Algorithm: crypto.SHA256,
	Host: "example.com",
	Path: "/inbox",
	KeyID: "https://snippet.social/@juunini#main-key",
})

type Signature

type Signature struct {
	PrivateKey *rsa.PrivateKey
	Algorithm  crypto.Hash
	Date       string
	Digest     string
	Host       string
	Path       string
	KeyID      string
}

Example:

privateKey, err := signature_header.PrivateKeyFromBytes(privateKeyBytes)
date := signature_header.Date()
digest := signature_header.Digest(crypto.SHA256, message)
signature, err := signature_header.Signature{
  PrivateKey: privateKey,
  Algorithm:  crypto.SHA256,
  Date:       date,
  Digest:     digest,
  Host:       "yodangang.express",
  Path:       "/users/9iffvxhojp/inbox",
  KeyID:      "https://snippet.cloudmt.co.kr/@juunini#main-key",
}.String()

func (Signature) String

func (s Signature) String() (string, error)

type Verifier

type Verifier struct {
	Method  string
	URL     string
	Headers map[string]string
	// contains filtered or unexported fields
}

func (*Verifier) VerifyWithActor

func (v *Verifier) VerifyWithActor(actor string) error

func (*Verifier) VerifyWithBody

func (v *Verifier) VerifyWithBody(body []byte) error

func (*Verifier) VerifyWithPublicKey

func (v *Verifier) VerifyWithPublicKey(publicKey crypto.PublicKey) error

func (*Verifier) VerifyWithPublicKeyStr

func (v *Verifier) VerifyWithPublicKeyStr(publicKeyStr string) error