Skip to content

Commit 83d7d7f

Browse files
AGWAAGWA
committed
Remove automatic registration of GSS provider
This removes the dependency from the kerberos module to the pq module, which would have complicated releases.
1 parent e4e4fd4 commit 83d7d7f

File tree

7 files changed

+35
-47
lines changed

7 files changed

+35
-47
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
## Optional Features
2424

25-
* GSS (Kerberos) auth (to use, import `github.com/lib/pq/auth/kerberos`)
25+
* GSS (Kerberos) auth (to use, see GoDoc)
2626

2727
## Tests
2828

‎auth/kerberos/go.mod

-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@ module github.com/lib/pq/auth/kerberos
22

33
go 1.13
44

5-
replace github.com/lib/pq => ../..
6-
75
require (
86
github.com/alexbrainman/sspi v0.0.0-20180613141037-e580b900e9f5
97
github.com/jcmturner/gokrb5/v8 v8.2.0
10-
github.com/lib/pq v1.6.0
118
)

‎auth/kerberos/go.sum

-9
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ github.com/jcmturner/gokrb5/v8 v8.2.0 h1:lzPl/30ZLkTveYsYZPKMcgXc8MbnE6RsTd4F9Kg
2020
github.com/jcmturner/gokrb5/v8 v8.2.0/go.mod h1:T1hnNppQsBtxW0tCHMHTkAt8n/sABdzZgZdoFrZaZNM=
2121
github.com/jcmturner/rpc/v2 v2.0.2 h1:gMB4IwRXYsWw4Bc6o/az2HJgFUA1ffSh90i26ZJ6Xl0=
2222
github.com/jcmturner/rpc/v2 v2.0.2/go.mod h1:VUJYCIDm3PVOEHw8sgt091/20OJjskO/YJki3ELg/Hc=
23-
github.com/lib/pq v1.6.0 h1:I5DPxhYJChW9KYc66se+oKFFQX6VuQrKiprsX6ivRZc=
24-
github.com/lib/pq v1.6.0/go.mod h1:4vXEAYvW1fRQ2/FhZ78H73A60MHw1geSm145z2mdY1g=
2523
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
2624
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
2725
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
@@ -30,8 +28,6 @@ github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81P
3028
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
3129
golang.org/x/crypto v0.0.0-20200117160349-530e935923ad h1:Jh8cai0fqIK+f6nG0UgPW5wFk8wmiMhM3AyciDBdtQg=
3230
golang.org/x/crypto v0.0.0-20200117160349-530e935923ad/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
33-
golang.org/x/crypto v0.0.0-20200311171314-f7b00557c8c4 h1:QmwruyY+bKbDDL0BaglrbZABEali68eoMFhTZpCjYVA=
34-
golang.org/x/crypto v0.0.0-20200311171314-f7b00557c8c4/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
3531
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
3632
golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa h1:F+8P+gmewFQYRk6JoLQLwjBCTu3mcIURZfNkVweuRKA=
3733
golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
@@ -40,10 +36,5 @@ golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7w
4036
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
4137
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
4238
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
43-
gopkg.in/jcmturner/aescts.v1 v1.0.1/go.mod h1:nsR8qBOg+OucoIW+WMhB3GspUQXq9XorLnQb9XtvcOo=
44-
gopkg.in/jcmturner/dnsutils.v1 v1.0.1/go.mod h1:m3v+5svpVOhtFAP/wSz+yzh4Mc0Fg7eRhxkJMWSIz9Q=
45-
gopkg.in/jcmturner/goidentity.v3 v3.0.0/go.mod h1:oG2kH0IvSYNIu80dVAyu/yoefjq1mNfM5bm88whjWx4=
46-
gopkg.in/jcmturner/gokrb5.v7 v7.5.0/go.mod h1:l8VISx+WGYp+Fp7KRbsiUuXTTOnxIc3Tuvyavf11/WM=
47-
gopkg.in/jcmturner/rpc.v1 v1.1.0/go.mod h1:YIdkC4XfD6GXbzje11McwsDuOlZQSb9W4vfLvuNnlv8=
4839
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
4940
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

‎auth/kerberos/krb_unix.go

+8-13
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,20 @@ import (
1212
"github.com/jcmturner/gokrb5/v8/config"
1313
"github.com/jcmturner/gokrb5/v8/credentials"
1414
"github.com/jcmturner/gokrb5/v8/spnego"
15-
"github.com/lib/pq"
1615
)
1716

1817
/*
1918
* UNIX Kerberos support, using jcmturner's pure-go
2019
* implementation
2120
*/
2221

23-
// Implements the Gss interface
24-
type gss struct {
22+
// Implements the pq.Gss interface
23+
type Gss struct {
2524
cli *client.Client
2625
}
2726

28-
func NewGSS() (pq.Gss, error) {
29-
g := &gss{}
27+
func NewGSS() (*Gss, error) {
28+
g := &Gss{}
3029
err := g.init()
3130

3231
if err != nil {
@@ -36,7 +35,7 @@ func NewGSS() (pq.Gss, error) {
3635
return g, nil
3736
}
3837

39-
func (g *gss) init() error {
38+
func (g *Gss) init() error {
4039
cfgPath, ok := os.LookupEnv("KRB5_CONFIG")
4140
if !ok {
4241
cfgPath = "/etc/krb5.conf"
@@ -76,7 +75,7 @@ func (g *gss) init() error {
7675
return nil
7776
}
7877

79-
func (g *gss) GetInitToken(host string, service string) ([]byte, error) {
78+
func (g *Gss) GetInitToken(host string, service string) ([]byte, error) {
8079

8180
// Resolve the hostname down to an 'A' record, if required (usually, it is)
8281
if g.cli.Config.LibDefaults.DNSCanonicalizeHostname {
@@ -92,7 +91,7 @@ func (g *gss) GetInitToken(host string, service string) ([]byte, error) {
9291
return g.GetInitTokenFromSpn(spn)
9392
}
9493

95-
func (g *gss) GetInitTokenFromSpn(spn string) ([]byte, error) {
94+
func (g *Gss) GetInitTokenFromSpn(spn string) ([]byte, error) {
9695
s := spnego.SPNEGOClient(g.cli, spn)
9796

9897
st, err := s.InitSecContext()
@@ -108,7 +107,7 @@ func (g *gss) GetInitTokenFromSpn(spn string) ([]byte, error) {
108107
return b, nil
109108
}
110109

111-
func (g *gss) Continue(inToken []byte) (done bool, outToken []byte, err error) {
110+
func (g *Gss) Continue(inToken []byte) (done bool, outToken []byte, err error) {
112111
t := &spnego.SPNEGOToken{}
113112
err = t.Unmarshal(inToken)
114113
if err != nil {
@@ -122,7 +121,3 @@ func (g *gss) Continue(inToken []byte) (done bool, outToken []byte, err error) {
122121

123122
return true, nil, nil
124123
}
125-
126-
func init() {
127-
pq.RegisterNewGSSFunc(NewGSS)
128-
}

‎auth/kerberos/krb_windows.go

+8-12
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ package kerberos
55
import (
66
"github.com/alexbrainman/sspi"
77
"github.com/alexbrainman/sspi/negotiate"
8-
"github.com/lib/pq"
98
)
109

11-
type gss struct {
10+
// Implements the pq.Gss interface
11+
type Gss struct {
1212
creds *sspi.Credentials
1313
ctx *negotiate.ClientContext
1414
}
1515

16-
func NewGSS() (pq.Gss, error) {
17-
g := &gss{}
16+
func NewGSS() (*Gss, error) {
17+
g := &Gss{}
1818
err := g.init()
1919

2020
if err != nil {
@@ -24,7 +24,7 @@ func NewGSS() (pq.Gss, error) {
2424
return g, nil
2525
}
2626

27-
func (g *gss) init() error {
27+
func (g *Gss) init() error {
2828
creds, err := negotiate.AcquireCurrentUserCredentials()
2929
if err != nil {
3030
return err
@@ -34,7 +34,7 @@ func (g *gss) init() error {
3434
return nil
3535
}
3636

37-
func (g *gss) GetInitToken(host string, service string) ([]byte, error) {
37+
func (g *Gss) GetInitToken(host string, service string) ([]byte, error) {
3838

3939
host, err := canonicalizeHostname(host)
4040
if err != nil {
@@ -46,7 +46,7 @@ func (g *gss) GetInitToken(host string, service string) ([]byte, error) {
4646
return g.GetInitTokenFromSpn(spn)
4747
}
4848

49-
func (g *gss) GetInitTokenFromSpn(spn string) ([]byte, error) {
49+
func (g *Gss) GetInitTokenFromSpn(spn string) ([]byte, error) {
5050
ctx, token, err := negotiate.NewClientContext(g.creds, spn)
5151
if err != nil {
5252
return nil, err
@@ -57,10 +57,6 @@ func (g *gss) GetInitTokenFromSpn(spn string) ([]byte, error) {
5757
return token, nil
5858
}
5959

60-
func (g *gss) Continue(inToken []byte) (done bool, outToken []byte, err error) {
60+
func (g *Gss) Continue(inToken []byte) (done bool, outToken []byte, err error) {
6161
return g.ctx.Update(inToken)
6262
}
63-
64-
func init() {
65-
pq.RegisterNewGSSFunc(NewGSS)
66-
}

‎doc.go

+7-3
Original file line numberDiff line numberDiff line change
@@ -247,10 +247,14 @@ https://godoc.org/github.com/lib/pq/example/listen.
247247
Kerberos Support
248248
249249
250-
If you need support for Kerberos authentication, add the following import
251-
statement to your program:
250+
If you need support for Kerberos authentication, add the following to your main
251+
package:
252252
253-
import _ "github.com/lib/pq/auth/kerberos"
253+
import "github.com/lib/pq/auth/kerberos"
254+
255+
func init() {
256+
pq.RegisterGSSProvider(func() (pq.Gss, error) { return kerberos.NewGSS() })
257+
}
254258
255259
This package is in a separate module so that users who don't need Kerberos
256260
don't have to download unnecessary dependencies.

‎krb.go

+11-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
package pq
22

3-
// A function that creates a GSS authentication provider. You
4-
// only need to care about this type if you are writing a GSS
5-
// authentication provider.
3+
// A function that creates a GSS authentication provider,
4+
// for use with RegisterGSSProvider.
65
type NewGSSFunc func() (Gss, error)
76

87
var newGss NewGSSFunc
98

109
// Register the function for creating a GSS authentication provider.
11-
// You only need to care about this function if you are writing a
12-
// GSS authentication provider.
13-
func RegisterNewGSSFunc(newGssArg NewGSSFunc) {
10+
// For example, if you need to use Kerberos to authenticate with your server,
11+
// add this to your main package:
12+
//
13+
// import "github.com/lib/pq/auth/kerberos"
14+
//
15+
// func init() {
16+
// pq.RegisterGSSProvider(func() (pq.Gss, error) { return kerberos.NewGSS() })
17+
// }
18+
func RegisterGSSProvider(newGssArg NewGSSFunc) {
1419
newGss = newGssArg
1520
}
1621

0 commit comments

Comments
 (0)