12199391122

Committed 06 Dec 2024 01:10PM UTC coverage: 49.807% (-9.1%) from 58.933%

Build # 12199391122

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9337 from Guayaba221/patch-1

chore: fix typo in ruby.md

Run Details

100137 of 201051 relevant lines covered (49.81%)

2.07 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

55.56

/macaroons/constraints.go

package macaroons

import (
        "bytes"
        "context"
        "fmt"
        "net"
        "strings"
        "time"

        "google.golang.org/grpc/peer"
        "gopkg.in/macaroon-bakery.v2/bakery/checkers"
        macaroon "gopkg.in/macaroon.v2"
)

const (
        // CondLndCustom is the first party caveat condition name that is used
        // for all custom caveats in lnd. Every custom caveat entry will be
        // encoded as the string
        // "lnd-custom <custom-caveat-name> <custom-caveat-condition>"
        // in the serialized macaroon. We choose a single space as the delimiter
        // between the because that is also used by the macaroon bakery library.
        CondLndCustom = "lnd-custom"
)

// CustomCaveatAcceptor is an interface that contains a single method for
// checking whether a macaroon with the given custom caveat name should be
// accepted or not.
type CustomCaveatAcceptor interface {
        // CustomCaveatSupported returns nil if a macaroon with the given custom
        // caveat name can be validated by any component in lnd (for example an
        // RPC middleware). If no component is registered to handle the given
        // custom caveat then an error must be returned. This method only checks
        // the availability of a validating component, not the validity of the
        // macaroon itself.
        CustomCaveatSupported(customCaveatName string) error
}

// Constraint type adds a layer of indirection over macaroon caveats.
type Constraint func(*macaroon.Macaroon) error

// Checker type adds a layer of indirection over macaroon checkers. A Checker
// returns the name of the checker and the checker function; these are used to
// register the function with the bakery service's compound checker.
type Checker func() (string, checkers.Func)

// AddConstraints returns new derived macaroon by applying every passed
// constraint and tightening its restrictions.
func AddConstraints(mac *macaroon.Macaroon,
        cs ...Constraint) (*macaroon.Macaroon, error) {

        // The macaroon library's Clone() method has a subtle bug that doesn't
        // correctly clone all caveats. We need to use our own, safe clone
        // function instead.
        newMac, err := SafeCopyMacaroon(mac)
        if err != nil {
                return nil, err
        }

        for _, constraint := range cs {
                if err := constraint(newMac); err != nil {
                        return nil, err
                }
        }
        return newMac, nil
}

// Each *Constraint function is a functional option, which takes a pointer
// to the macaroon and adds another restriction to it. For each *Constraint,
// the corresponding *Checker is provided if not provided by default.

// TimeoutConstraint restricts the lifetime of the macaroon
// to the amount of seconds given.
func TimeoutConstraint(seconds int64) func(*macaroon.Macaroon) error {
        return func(mac *macaroon.Macaroon) error {
                macaroonTimeout := time.Duration(seconds)
                requestTimeout := time.Now().Add(time.Second * macaroonTimeout)
                caveat := checkers.TimeBeforeCaveat(requestTimeout)
                return mac.AddFirstPartyCaveat([]byte(caveat.Condition))
        }
}

// IPLockConstraint locks macaroon to a specific IP address.
// If address is an empty string, this constraint does nothing to
// accommodate default value's desired behavior.
func IPLockConstraint(ipAddr string) func(*macaroon.Macaroon) error {
        return func(mac *macaroon.Macaroon) error {
                if ipAddr != "" {
                        macaroonIPAddr := net.ParseIP(ipAddr)
                        if macaroonIPAddr == nil {
                                return fmt.Errorf("incorrect macaroon IP-" +
                                        "lock address")
                        }
                        caveat := checkers.Condition("ipaddr",
                                macaroonIPAddr.String())
                        return mac.AddFirstPartyCaveat([]byte(caveat))
                }
                return nil
        }
}

// IPLockChecker accepts client IP from the validation context and compares it
// with IP locked in the macaroon. It is of the `Checker` type.
func IPLockChecker() (string, checkers.Func) {
        return "ipaddr", func(ctx context.Context, cond, arg string) error {
                // Get peer info and extract IP address from it for macaroon
                // check.
                pr, ok := peer.FromContext(ctx)
                if !ok {
                        return fmt.Errorf("unable to get peer info from context")
                }
                peerAddr, _, err := net.SplitHostPort(pr.Addr.String())
                if err != nil {
                        return fmt.Errorf("unable to parse peer address")
                }

                if !net.ParseIP(arg).Equal(net.ParseIP(peerAddr)) {
                        msg := "macaroon locked to different IP address"
                        return fmt.Errorf(msg)
                }
                return nil
        }
}

// CustomConstraint returns a function that adds a custom caveat condition to
// a macaroon.
func CustomConstraint(name, condition string) func(*macaroon.Macaroon) error {
        return func(mac *macaroon.Macaroon) error {
                // We rely on a name being set for the interception, so don't
                // allow creating a caveat without a name in the first place.
                if name == "" {
                        return fmt.Errorf("name cannot be empty")
                }

                // The inner (custom) condition is optional.
                outerCondition := fmt.Sprintf("%s %s", name, condition)
                if condition == "" {
                        outerCondition = name
                }

                caveat := checkers.Condition(CondLndCustom, outerCondition)
                return mac.AddFirstPartyCaveat([]byte(caveat))
        }
}

// CustomChecker returns a Checker function that is used by the macaroon bakery
// library to check whether a custom caveat is supported by lnd in general or
// not. Support in this context means: An additional gRPC interceptor was set up
// that validates the content (=condition) of the custom caveat. If such an
// interceptor is in place then the acceptor should return a nil error. If no
// interceptor exists for the custom caveat in the macaroon of a request context
// then a non-nil error should be returned and the macaroon is rejected as a
// whole.
func CustomChecker(acceptor CustomCaveatAcceptor) Checker {
        // We return the general name of all lnd custom macaroons and a function
        // that splits the outer condition to extract the name of the custom
        // condition and the condition itself. In the bakery library that's used
        // here, a caveat always has the following form:
        //
        // <condition-name> <condition-value>
        //
        // Because a checker function needs to be bound to the condition name we
        // have to choose a static name for the first part ("lnd-custom", see
        // CondLndCustom. Otherwise we'd need to register a new Checker function
        // for each custom caveat that's registered. To allow for a generic
        // custom caveat handling, we just add another layer and expand the
        // initial <condition-value> into
        //
        // "<custom-condition-name> <custom-condition-value>"
        //
        // The full caveat string entry of a macaroon that uses this generic
        // mechanism would therefore look like this:
        //
        // "lnd-custom <custom-condition-name> <custom-condition-value>"
        checker := func(_ context.Context, _, outerCondition string) error {
                if outerCondition != strings.TrimSpace(outerCondition) {
                        return fmt.Errorf("unexpected white space found in " +
                                "caveat condition")
                }
                if outerCondition == "" {
                        return fmt.Errorf("expected custom caveat, got empty " +
                                "string")
                }

                // The condition part of the original caveat is now name and
                // condition of the custom caveat (we add a layer of conditions
                // to allow one custom checker to work for all custom lnd
                // conditions that implement arbitrary business logic).
                parts := strings.Split(outerCondition, " ")
                customCaveatName := parts[0]

                return acceptor.CustomCaveatSupported(customCaveatName)
        }

        return func() (string, checkers.Func) {
                return CondLndCustom, checker
        }
}

// HasCustomCaveat tests if the given macaroon has a custom caveat with the
// given custom caveat name.
func HasCustomCaveat(mac *macaroon.Macaroon, customCaveatName string) bool {
        if mac == nil {
                return false
        }

        caveatPrefix := []byte(fmt.Sprintf(
                "%s %s", CondLndCustom, customCaveatName,
        ))
        for _, caveat := range mac.Caveats() {
                if bytes.HasPrefix(caveat.Id, caveatPrefix) {
                        return true
                }
        }

        return false
}

// GetCustomCaveatCondition returns the custom caveat condition for the given
// custom caveat name from the given macaroon.
func GetCustomCaveatCondition(mac *macaroon.Macaroon,
        customCaveatName string) string {

        if mac == nil {
                return ""
        }

        caveatPrefix := []byte(fmt.Sprintf(
                "%s %s ", CondLndCustom, customCaveatName,
        ))
        for _, caveat := range mac.Caveats() {
                // The caveat id has a format of
                // "lnd-custom [custom-caveat-name] [custom-caveat-condition]"
                // and we only want the condition part. If we match the prefix
                // part we return the condition that comes after the prefix.
                if bytes.HasPrefix(caveat.Id, caveatPrefix) {
                        caveatSplit := strings.SplitN(
                                string(caveat.Id),
                                string(caveatPrefix),
                                2,
                        )
                        if len(caveatSplit) == 2 {
                                return caveatSplit[1]
                        }
                }
        }

        // We didn't find a condition for the given custom caveat name.
        return ""
}

1	package macaroons
2
3	import (
4	"bytes"
5	"context"
6	"fmt"
7	"net"
8	"strings"
9	"time"
10
11	"google.golang.org/grpc/peer"
12	"gopkg.in/macaroon-bakery.v2/bakery/checkers"
13	macaroon "gopkg.in/macaroon.v2"
14	)
15
16	const (
17	// CondLndCustom is the first party caveat condition name that is used
18	// for all custom caveats in lnd. Every custom caveat entry will be
19	// encoded as the string
20	// "lnd-custom <custom-caveat-name> <custom-caveat-condition>"
21	// in the serialized macaroon. We choose a single space as the delimiter
22	// between the because that is also used by the macaroon bakery library.
23	CondLndCustom = "lnd-custom"
24	)
25
26	// CustomCaveatAcceptor is an interface that contains a single method for
27	// checking whether a macaroon with the given custom caveat name should be
28	// accepted or not.
29	type CustomCaveatAcceptor interface {
30	// CustomCaveatSupported returns nil if a macaroon with the given custom
31	// caveat name can be validated by any component in lnd (for example an
32	// RPC middleware). If no component is registered to handle the given
33	// custom caveat then an error must be returned. This method only checks
34	// the availability of a validating component, not the validity of the
35	// macaroon itself.
36	CustomCaveatSupported(customCaveatName string) error
37	}
38
39	// Constraint type adds a layer of indirection over macaroon caveats.
40	type Constraint func(*macaroon.Macaroon) error
41
42	// Checker type adds a layer of indirection over macaroon checkers. A Checker
43	// returns the name of the checker and the checker function; these are used to
44	// register the function with the bakery service's compound checker.
45	type Checker func() (string, checkers.Func)
46
47	// AddConstraints returns new derived macaroon by applying every passed
48	// constraint and tightening its restrictions.
49	func AddConstraints(mac *macaroon.Macaroon,
50	cs ...Constraint) (*macaroon.Macaroon, error) {	×
51		×
52	// The macaroon library's Clone() method has a subtle bug that doesn't	×
53	// correctly clone all caveats. We need to use our own, safe clone	×
54	// function instead.	×
55	newMac, err := SafeCopyMacaroon(mac)	×
56	if err != nil {	×
57	return nil, err	×
58	}	×
59
60	for _, constraint := range cs {	×
61	if err := constraint(newMac); err != nil {	×
62	return nil, err	×
63	}	×
64	}
65	return newMac, nil	×
66	}
67
68	// Each *Constraint function is a functional option, which takes a pointer
69	// to the macaroon and adds another restriction to it. For each *Constraint,
70	// the corresponding *Checker is provided if not provided by default.
71
72	// TimeoutConstraint restricts the lifetime of the macaroon
73	// to the amount of seconds given.
74	func TimeoutConstraint(seconds int64) func(*macaroon.Macaroon) error {	×
75	return func(mac *macaroon.Macaroon) error {	×
76	macaroonTimeout := time.Duration(seconds)	×
77	requestTimeout := time.Now().Add(time.Second * macaroonTimeout)	×
78	caveat := checkers.TimeBeforeCaveat(requestTimeout)	×
79	return mac.AddFirstPartyCaveat([]byte(caveat.Condition))	×
80	}	×
81	}
82
83	// IPLockConstraint locks macaroon to a specific IP address.
84	// If address is an empty string, this constraint does nothing to
85	// accommodate default value's desired behavior.
86	func IPLockConstraint(ipAddr string) func(*macaroon.Macaroon) error {	×
87	return func(mac *macaroon.Macaroon) error {	×
88	if ipAddr != "" {	×
89	macaroonIPAddr := net.ParseIP(ipAddr)	×
90	if macaroonIPAddr == nil {	×
91	return fmt.Errorf("incorrect macaroon IP-" +	×
92	"lock address")	×
93	}	×
94	caveat := checkers.Condition("ipaddr",	×
95	macaroonIPAddr.String())	×
96	return mac.AddFirstPartyCaveat([]byte(caveat))	×
97	}
98	return nil	×
99	}
100	}
101
102	// IPLockChecker accepts client IP from the validation context and compares it
103	// with IP locked in the macaroon. It is of the `Checker` type.
104	func IPLockChecker() (string, checkers.Func) {	4✔
105	return "ipaddr", func(ctx context.Context, cond, arg string) error {	8✔
106	// Get peer info and extract IP address from it for macaroon	4✔
107	// check.	4✔
108	pr, ok := peer.FromContext(ctx)	4✔
109	if !ok {	4✔
110	return fmt.Errorf("unable to get peer info from context")	×
111	}	×
112	peerAddr, _, err := net.SplitHostPort(pr.Addr.String())	4✔
113	if err != nil {	4✔
114	return fmt.Errorf("unable to parse peer address")	×
115	}	×
116
117	if !net.ParseIP(arg).Equal(net.ParseIP(peerAddr)) {	8✔
118	msg := "macaroon locked to different IP address"	4✔
119	return fmt.Errorf(msg)	4✔
120	}	4✔
121	return nil	4✔
122	}
123	}
124
125	// CustomConstraint returns a function that adds a custom caveat condition to
126	// a macaroon.
127	func CustomConstraint(name, condition string) func(*macaroon.Macaroon) error {	×
128	return func(mac *macaroon.Macaroon) error {	×
129	// We rely on a name being set for the interception, so don't	×
130	// allow creating a caveat without a name in the first place.	×
131	if name == "" {	×
132	return fmt.Errorf("name cannot be empty")	×
133	}	×
134
135	// The inner (custom) condition is optional.
136	outerCondition := fmt.Sprintf("%s %s", name, condition)	×
137	if condition == "" {	×
138	outerCondition = name	×
139	}	×
140
141	caveat := checkers.Condition(CondLndCustom, outerCondition)	×
142	return mac.AddFirstPartyCaveat([]byte(caveat))	×
143	}
144	}
145
146	// CustomChecker returns a Checker function that is used by the macaroon bakery
147	// library to check whether a custom caveat is supported by lnd in general or
148	// not. Support in this context means: An additional gRPC interceptor was set up
149	// that validates the content (=condition) of the custom caveat. If such an
150	// interceptor is in place then the acceptor should return a nil error. If no
151	// interceptor exists for the custom caveat in the macaroon of a request context
152	// then a non-nil error should be returned and the macaroon is rejected as a
153	// whole.
154	func CustomChecker(acceptor CustomCaveatAcceptor) Checker {	4✔
155	// We return the general name of all lnd custom macaroons and a function	4✔
156	// that splits the outer condition to extract the name of the custom	4✔
157	// condition and the condition itself. In the bakery library that's used	4✔
158	// here, a caveat always has the following form:	4✔
159	//	4✔
160	// <condition-name> <condition-value>	4✔
161	//	4✔
162	// Because a checker function needs to be bound to the condition name we	4✔
163	// have to choose a static name for the first part ("lnd-custom", see	4✔
164	// CondLndCustom. Otherwise we'd need to register a new Checker function	4✔
165	// for each custom caveat that's registered. To allow for a generic	4✔
166	// custom caveat handling, we just add another layer and expand the	4✔
167	// initial <condition-value> into	4✔
168	//	4✔
169	// "<custom-condition-name> <custom-condition-value>"	4✔
170	//	4✔
171	// The full caveat string entry of a macaroon that uses this generic	4✔
172	// mechanism would therefore look like this:	4✔
173	//	4✔
174	// "lnd-custom <custom-condition-name> <custom-condition-value>"	4✔
175	checker := func(_ context.Context, _, outerCondition string) error {	8✔
176	if outerCondition != strings.TrimSpace(outerCondition) {	4✔
177	return fmt.Errorf("unexpected white space found in " +	×
178	"caveat condition")	×
179	}	×
180	if outerCondition == "" {	4✔
181	return fmt.Errorf("expected custom caveat, got empty " +	×
182	"string")	×
183	}	×
184
185	// The condition part of the original caveat is now name and
186	// condition of the custom caveat (we add a layer of conditions
187	// to allow one custom checker to work for all custom lnd
188	// conditions that implement arbitrary business logic).
189	parts := strings.Split(outerCondition, " ")	4✔
190	customCaveatName := parts[0]	4✔
191		4✔
192	return acceptor.CustomCaveatSupported(customCaveatName)	4✔
193	}
194
195	return func() (string, checkers.Func) {	8✔
196	return CondLndCustom, checker	4✔
197	}	4✔
198	}
199
200	// HasCustomCaveat tests if the given macaroon has a custom caveat with the
201	// given custom caveat name.
202	func HasCustomCaveat(mac *macaroon.Macaroon, customCaveatName string) bool {	4✔
203	if mac == nil {	4✔
204	return false	×
205	}	×
206
207	caveatPrefix := []byte(fmt.Sprintf(	4✔
208	"%s %s", CondLndCustom, customCaveatName,	4✔
209	))	4✔
210	for _, caveat := range mac.Caveats() {	8✔
211	if bytes.HasPrefix(caveat.Id, caveatPrefix) {	8✔
212	return true	4✔
213	}	4✔
214	}
215
216	return false	4✔
217	}
218
219	// GetCustomCaveatCondition returns the custom caveat condition for the given
220	// custom caveat name from the given macaroon.
221	func GetCustomCaveatCondition(mac *macaroon.Macaroon,
222	customCaveatName string) string {	4✔
223		4✔
224	if mac == nil {	4✔
225	return ""	×
226	}	×
227
228	caveatPrefix := []byte(fmt.Sprintf(	4✔
229	"%s %s ", CondLndCustom, customCaveatName,	4✔
230	))	4✔
231	for _, caveat := range mac.Caveats() {	8✔
232	// The caveat id has a format of	4✔
233	// "lnd-custom [custom-caveat-name] [custom-caveat-condition]"	4✔
234	// and we only want the condition part. If we match the prefix	4✔
235	// part we return the condition that comes after the prefix.	4✔
236	if bytes.HasPrefix(caveat.Id, caveatPrefix) {	8✔
237	caveatSplit := strings.SplitN(	4✔
238	string(caveat.Id),	4✔
239	string(caveatPrefix),	4✔
240	2,	4✔
241	)	4✔
242	if len(caveatSplit) == 2 {	8✔
243	return caveatSplit[1]	4✔
244	}	4✔
245	}
246	}
247
248	// We didn't find a condition for the given custom caveat name.
249	return ""	4✔
250	}

lightningnetwork / lnd / 12199391122

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous