Macaroon bakery

Summary

The macaroon bakery package can be used to create, manipulate and verify macaroons without having to worry about how they will be transported or stored. The package provides a set of convenient methods and abstractions that can be easily integrated into any application.

Installation

npm install @canonical/macaroon-bakery

Usage

import { Bakery } from "@canonical/macaroon-bakery";
const bakery = new Bakery();

const url = "http://example.com/";
const headers = { header: "42" };
const callback = () => 42;

// will set additional headers:
// "Bakery-Protocol-Version": "2"
// and any stored macaroon related to the website http://example.com/
bakery.get(url, headers, callback);

API Reference

Javascript implementation of the Macaroon Bakery.

bakeryjs

bakeryjs~Bakery

A macaroon bakery implementation.

The bakery implements the protocol used to acquire and discharge macaroons over HTTP.

Kind: inner class of bakeryjs

~Bakery

new Bakery(config)

Initialize a macaroon bakery with the given parameters.

Param	Description
config	optional config.
config.onSuccess	a function to be called when the request completes properly.
config.protocolVersion	the macaroon protocol version that the bakery should use.
config.storage	the storage used to persist macaroons. It must implement the following interface:
config.storage.get	get(key) -> value.
config.storage.set	set(key, value, callback): the callback is called without arguments when the set operation has been performed. If not provided, it defaults to BakeryStorage using an in memory store.
config.visitPage	the function used to visit the identity provider page when required, defaulting to opening a pop up window. It receives an error object.
config.visitPage.Info	an object containing relevant info for the visit handling.
config.visitPage.Info.WaitURL	the url to wait on for IdM discharge.
config.visitPage.Info.VisitURL	the url to visit to authenticate with the IdM.
config.visitPage.jujugui	an optional value specifying a method to use against idm to authenticate. Used in non interactive authentication scenarios.
config.sendRequest	a function used to make XHR HTTP requests, with the following signature: func(path, method, headers, body, withCredentials, callback) -> xhr. By default an internal function is used. This is mostly for testing.

bakery.sendRequest(url, method, headers, body, callback) ⇒

Send an HTTP request to the given URL with the given HTTP method, headers and body. The given callback receives an error and a response when the request is complete.

Kind: instance method of Bakery
Returns: the XHR instance.

Param	Description
url	The URL to which to send the request.
method	The HTTP method, like "get" or "POST".
headers	Headers that must be included in the request. Note that bakery specific headers are automatically added internally.
body	The request body if it applies, or null.
callback	A function called when the response is received from the remote URL. It receives a tuple (error, response). If the request succeeds the error is null.

bakery.get()

Send an HTTP GET request to the given URL with the given headers. The given callback receives an error and a response when the request is complete.

  See the "sendRequest" method above for a description of the parameters.