-
Notifications
You must be signed in to change notification settings - Fork 18
/
server.go
231 lines (212 loc) · 5.94 KB
/
server.go
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
package ldaptest
import (
"fmt"
"net/url"
"os"
"os/exec"
"path/filepath"
"text/template"
"time"
dex_ldap "github.com/dexidp/dex/connector/ldap"
"github.com/sky-uk/osprey/v2/e2e/clitest"
"github.com/sky-uk/osprey/v2/e2e/ssltest"
"github.com/sky-uk/osprey/v2/e2e/util"
)
const (
defaultLDAPHostname = "localhost"
defaultLDAPPort = 10389
defaultLDAPSecurePort = 10636
rootDN = "cn=admin,dc=example,dc=org"
rootPwd = "admin"
)
// TestLDAP holds the info about the running process and its configuration
type TestLDAP struct {
clitest.AsyncTestCommand
DexConfig *dex_ldap.Config
TLSCert string
}
// SLAPDConfig is the struct used to execute the SLAPD config template.
type SLAPDConfig struct {
// Directory for database to be written to.
LDAPDir string
// List of schema files to include.
Includes []string
// TLS assets for LDAPS.
TLSKeyPath string
TLSCertPath string
// Bind properties for SLAPD
RootDN string
RootPwd string
// File where the config is written to
configPath string
}
// Start asynchronously starts a new SLAPD server using the configuration from testdata and the default schema
// Returns the TestLDAP instance if it has been started, and any errors that may have happen.
// Loading the test data may return an error AND the running TestLDAP instance.
func Start(testDir string) (*TestLDAP, error) {
validateBinaries("slapd", "ldapadd")
ldapDir := fmt.Sprintf("%s/ldap", testDir)
ldapConfig, err := generateSLAPDConfig(ldapDir)
if err != nil {
return nil, err
}
testLDAP, err := startTestServer(ldapConfig)
if err != nil {
return testLDAP, err
}
if err = loadSchemaData(); err != nil {
return testLDAP, err
}
return testLDAP, nil
}
// Stop stops asynchronously the instance of the SLAPD server.
// The server output is printed only if the server terminated in an error.
func Stop(server *TestLDAP) {
if server == nil {
return
}
server.Stop()
if !server.Successful() {
server.PrintOutput()
}
}
// newLDAPConfig returns a default LDAP configuration for dex
func newLDAPConfig(slapdConfig *SLAPDConfig) *dex_ldap.Config {
config := &dex_ldap.Config{}
config.RootCA = slapdConfig.TLSCertPath
config.Host = host()
config.InsecureSkipVerify = true
config.InsecureNoSSL = true
config.BindDN = rootDN
config.BindPW = rootPwd
config.UserSearch.BaseDN = "ou=People,dc=example,dc=org"
config.UserSearch.Filter = "(objectClass=person)"
config.UserSearch.Username = "cn"
config.UserSearch.IDAttr = "DN"
config.UserSearch.EmailAttr = "mail"
config.UserSearch.NameAttr = "cn"
config.GroupSearch.BaseDN = "ou=Groups,dc=example,dc=org"
config.GroupSearch.Filter = "(objectClass=groupOfNames)"
config.GroupSearch.UserAttr = "DN"
config.GroupSearch.GroupAttr = "member"
config.GroupSearch.NameAttr = "cn"
return config
}
func validateBinaries(binaries ...string) error {
for _, cmd := range binaries {
if _, err := exec.LookPath(cmd); err != nil {
return fmt.Errorf("%s not available", cmd)
}
}
return nil
}
func generateSLAPDConfig(ldapDir string) (config *SLAPDConfig, err error) {
td, err := util.TestDataDir()
if err != nil {
return nil, err
}
tmplIncludes, err := includes(td)
if err != nil {
return nil, err
}
tlsCert, tlsKey := ssltest.CreateCertificates("localhost", ldapDir)
configPath := filepath.Join(ldapDir, "ldap.conf")
config = &SLAPDConfig{
LDAPDir: ldapDir,
configPath: configPath,
Includes: tmplIncludes,
RootDN: rootDN,
RootPwd: rootPwd,
TLSCertPath: tlsCert,
TLSKeyPath: tlsKey,
}
writeTemplateToFile(filepath.Join(td, "ldap.conf.template"), config.configPath, config)
return config, nil
}
func writeTemplateToFile(templatePath, targetPath string, config interface{}) error {
t, err := template.ParseFiles(templatePath)
if err != nil {
return fmt.Errorf("failed to parse %s: %w", templatePath, err)
}
file, err := os.Create(targetPath)
if err != nil {
return fmt.Errorf("failed to create %s: %w", targetPath, err)
}
defer file.Close()
err = t.Execute(file, config)
if err != nil {
return fmt.Errorf("failed to write %s: %w", targetPath, err)
}
return nil
}
// Standard OpenLDAP schema files to include.
var includeFiles = []string{
"core.schema",
"cosine.schema",
"inetorgperson.schema",
"misc.schema",
"nis.schema",
"openldap.schema",
}
func includes(wd string) (paths []string, err error) {
for _, f := range includeFiles {
p := filepath.Join(wd, f)
if _, err := os.Stat(p); err != nil {
return []string{}, fmt.Errorf("failed to find schema file: %s %w", p, err)
}
paths = append(paths, p)
}
return paths, nil
}
func startTestServer(ldapConfig *SLAPDConfig) (*TestLDAP, error) {
socketPath := url.QueryEscape(filepath.Join(ldapConfig.LDAPDir, "ldap.unix"))
cmd := clitest.NewAsyncCommand("slapd",
"-d", "0",
"-h", fmt.Sprintf("ldap://%s ldaps://%s ldapi://%s", host(), secureHost(), socketPath),
"-f", ldapConfig.configPath,
)
ldapServer := &TestLDAP{
AsyncTestCommand: cmd,
TLSCert: ldapConfig.TLSCertPath,
DexConfig: newLDAPConfig(ldapConfig),
}
ldapServer.Run()
return ldapServer, ldapServer.Error()
}
func loadSchemaData() error {
td, err := util.TestDataDir()
if err != nil {
return err
}
schemaPath := filepath.Join(td, "schema.ldap")
var ldapAdd clitest.TestCommand
// Try a few times to connect to the LDAP server. Sometimes it can take a while for it to come up.
wait := 500 * time.Millisecond
for i := 0; i < 10; i++ {
time.Sleep(wait)
ldapAdd = clitest.NewCommand("ldapadd",
"-x",
"-D", rootDN,
"-w", rootPwd,
"-f", schemaPath,
"-H", fmt.Sprintf("ldap://%s", host()),
)
ldapAdd.Run()
if !ldapAdd.Successful() {
ldapAdd.PrintOutput()
wait = wait * 2 // backoff
continue
}
break
}
if !ldapAdd.Successful() {
return ldapAdd.Error()
}
return nil
}
func host() string {
return fmt.Sprintf("%s:%d", defaultLDAPHostname, defaultLDAPPort)
}
func secureHost() string {
return fmt.Sprintf("%s:%d", defaultLDAPHostname, defaultLDAPSecurePort)
}