1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | # macaroon -- import "gopkg.in/macaroon.v1" The macaroon package implements macaroons as described in the paper "Macaroons: Cookies with Contextual Caveats for Decentralized Authorization in the Cloud" (http://theory.stanford.edu/~ataly/Papers/macaroons.pdf) See the macaroon bakery packages at http://godoc.org/gopkg.in/macaroon-bakery.v0 for higher level services and operations that use macaroons. ## Usage #### type Caveat ```go type Caveat struct { Id string Location string } ``` #### type Macaroon ```go type Macaroon struct { } ``` Macaroon holds a macaroon. See Fig. 7 of http://theory.stanford.edu/~ataly/Papers/macaroons.pdf for a description of the data contained within. Macaroons are mutable objects - use Clone as appropriate to avoid unwanted mutation. #### func New ```go func New(rootKey []byte, id, loc string) (*Macaroon, error) ``` New returns a new macaroon with the given root key, identifier and location. #### func (*Macaroon) AddFirstPartyCaveat ```go func (m *Macaroon) AddFirstPartyCaveat(caveatId string) error ``` AddFirstPartyCaveat adds a caveat that will be verified by the target service. #### func (*Macaroon) AddThirdPartyCaveat ```go func (m *Macaroon) AddThirdPartyCaveat(rootKey []byte, caveatId string, loc string) error ``` AddThirdPartyCaveat adds a third-party caveat to the macaroon, using the given shared root key, caveat id and location hint. The caveat id should encode the root key in some way, either by encrypting it with a key known to the third party or by holding a reference to it stored in the third party's storage. #### func (*Macaroon) Bind ```go func (m *Macaroon) Bind(sig []byte) ``` Bind prepares the macaroon for being used to discharge the macaroon with the given signature sig. This must be used before it is used in the discharges argument to Verify. #### func (*Macaroon) Caveats ```go func (m *Macaroon) Caveats() []Caveat ``` Caveats returns the macaroon's caveats. This method will probably change, and it's important not to change the returned caveat. #### func (*Macaroon) Clone ```go func (m *Macaroon) Clone() *Macaroon ``` Clone returns a copy of the receiving macaroon. #### func (*Macaroon) Id ```go func (m *Macaroon) Id() string ``` Id returns the id of the macaroon. This can hold arbitrary information. #### func (*Macaroon) Location ```go func (m *Macaroon) Location() string ``` Location returns the macaroon's location hint. This is not verified as part of the macaroon. #### func (*Macaroon) MarshalBinary ```go func (m *Macaroon) MarshalBinary() ([]byte, error) ``` MarshalBinary implements encoding.BinaryMarshaler. #### func (*Macaroon) MarshalJSON ```go func (m *Macaroon) MarshalJSON() ([]byte, error) ``` MarshalJSON implements json.Marshaler. #### func (*Macaroon) Signature ```go func (m *Macaroon) Signature() []byte ``` Signature returns the macaroon's signature. #### func (*Macaroon) UnmarshalBinary ```go func (m *Macaroon) UnmarshalBinary(data []byte) error ``` UnmarshalBinary implements encoding.BinaryUnmarshaler. #### func (*Macaroon) UnmarshalJSON ```go func (m *Macaroon) UnmarshalJSON(jsonData []byte) error ``` UnmarshalJSON implements json.Unmarshaler. #### func (*Macaroon) Verify ```go func (m *Macaroon) Verify(rootKey []byte, check func(caveat string) error, discharges []*Macaroon) error ``` Verify verifies that the receiving macaroon is valid. The root key must be the same that the macaroon was originally minted with. The check function is called to verify each first-party caveat - it should return an error if the condition is not met. The discharge macaroons should be provided in discharges. Verify returns true if the verification succeeds; if returns (false, nil) if the verification fails, and (false, err) if the verification cannot be asserted (but may not be false). TODO(rog) is there a possible DOS attack that can cause this function to infinitely recurse? #### type Verifier ```go type Verifier interface { Verify(m *Macaroon, rootKey []byte) (bool, error) } ``` |
Commit History @buster-backports/main
0
»»
0
»»