package util

import "v.io/x/ref/services/identity/internal/util"

Package util implements miscellaneous utility functions needed by the identity HTTP server.

Index ¶

• func HTTPBadRequest(w http.ResponseWriter, req *http.Request, err error)
• func HTTPServerError(w http.ResponseWriter, err error)
• func RootCertificateDetails(b security.Blessings) (string, []byte, error)
• func WriteCertAndKey(host string, duration time.Duration) (string, string, error)
• type CSRFCop
• func NewCSRFCop(ctx *context.T) *CSRFCop
• func (c *CSRFCop) MaybeSetCookie(w http.ResponseWriter, req *http.Request, cookieName string) ([]byte, error)
• func (c *CSRFCop) NewToken(w http.ResponseWriter, r *http.Request, cookieName string, data interface{}) (string, error)
• func (c *CSRFCop) ValidateToken(token string, req *http.Request, cookieName string, decoded interface{}) error
• type Macaroon
• func NewMacaroon(principal security.Principal, data []byte) (Macaroon, error)
• func (m Macaroon) Decode(principal security.Principal) (input []byte, err error)
• type MacaroonMessage

Package Files ¶

blessings_info.go certs.go csrf.go doc.go macaroon.go write.go

func HTTPBadRequest ¶ Uses

func HTTPBadRequest(w http.ResponseWriter, req *http.Request, err error)

HTTPBadRequest sends an HTTP 400 error on 'w' and renders a pretty page. If err is not nil, it also renders the string representation of err in the response page.

func HTTPServerError ¶ Uses

func HTTPServerError(w http.ResponseWriter, err error)

ServerError sends an HTTP 500 error on 'w' and renders a pretty page that also has the string representation of err.

func RootCertificateDetails ¶ Uses

func RootCertificateDetails(b security.Blessings) (string, []byte, error)

Circuitious route to obtain the certificate chain because the use of security.MarshalBlessings is discouraged.

func WriteCertAndKey ¶ Uses

func WriteCertAndKey(host string, duration time.Duration) (string, string, error)

WriteCertAndKey creates a certificate and private key for a given host and duration and writes them to cert.pem and key.pem in tmpdir. It returns the locations of the files, or an error if one is encountered.

type CSRFCop ¶ Uses

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

CSRFCop implements utilities for generating and validating tokens for cross-site-request-forgery prevention (also called XSRF).

func NewCSRFCop ¶ Uses

func NewCSRFCop(ctx *context.T) *CSRFCop

func (*CSRFCop) MaybeSetCookie ¶ Uses

func (c *CSRFCop) MaybeSetCookie(w http.ResponseWriter, req *http.Request, cookieName string) ([]byte, error)

func (*CSRFCop) NewToken ¶ Uses

func (c *CSRFCop) NewToken(w http.ResponseWriter, r *http.Request, cookieName string, data interface{}) (string, error)

NewToken creates an anti-cross-site-request-forgery, aka CSRF aka XSRF token with some data bound to it that can be obtained by ValidateToken. It returns an error if the token could not be created.

func (*CSRFCop) ValidateToken ¶ Uses

func (c *CSRFCop) ValidateToken(token string, req *http.Request, cookieName string, decoded interface{}) error

ValidateToken checks the validity of the provided CSRF token for the provided request, and extracts the data encoded in the token into 'decoded'. If the token is invalid, return an error. This error should not be shown to end users, it is meant for the consumption by the server process only.

type Macaroon ¶ Uses

type Macaroon string

Macaroon encapsulates an arbitrary slice of data signed with a Private Key. Term borrowed from http://research.google.com/pubs/pub41892.html.

func NewMacaroon ¶ Uses

func NewMacaroon(principal security.Principal, data []byte) (Macaroon, error)

NewMacaroon creates an opaque token that encodes "data".

Input can be extracted from the returned token only if the Signature is valid.

func (Macaroon) Decode ¶ Uses

func (m Macaroon) Decode(principal security.Principal) (input []byte, err error)

Decode returns the input if the macaroon was signed by the current principal.

type MacaroonMessage ¶ Uses

type MacaroonMessage struct {
    Data []byte
    Sig  security.Signature
}