http

package

v0.0.0-...-b56449a Latest Latest Go to latest Published: Aug 8, 2015 License: MPL-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func PublicKey(serverURL string, client *http.Client) (*sf.PublicKey, error)

PublicKey requests a shadowfax server's public key. An error is returned if the server URL is not https.

type Client struct {
	// contains filtered or unexported fields
}

Client pushes and pops messages in the shadowfax messaging system.

func NewClient(keyPair *sf.KeyPair, serverURL string, serverKey *sf.PublicKey, client *http.Client) *Client

NewClient returns a new shadowfax client.

func (c *Client) Pop() ([]*PopMessage, error)

Pop retrieves messages addressed to the client.

func (c *Client) PublicKey() *sf.PublicKey

PublicKey returns the public key identity of the client.

func (c *Client) Push(recipient string, contents []byte) error

Push pushes a message to a recipient.

func (c *Client) Request(method string, path string, contents []byte) ([]byte, error)

Request encrypts a request to the server and decrypts the response.

If the client and server have securely exchanged keys out of band, confidentiality does not depend on TLS.

type Handler struct {
	// contains filtered or unexported fields
}

Handler handles HTTP requests as a shadowfax server.

func NewHandler(keyPair *sf.KeyPair, service storage.Service) *Handler

NewHandler returns a new Handler with public key pair and service backend.

func (h *Handler) Register(r *httprouter.Router)

Register sets up endpoint routing for a shadowfax server.

type PopMessage struct {
	ID       string
	Sender   string
	Contents []byte
}

PopMessage contains a message received.