From ea5c2ad54e076eda5dae9390b5fbdc160a82a61b Mon Sep 17 00:00:00 2001 From: William Petit Date: Wed, 6 Dec 2023 11:41:44 +0100 Subject: [PATCH] feat: add configurable ldap connection timeout --- conf/hydra-werther.conf | 6 ++++ internal/ldapclient/ldapclient.go | 51 ++++++++++++++++--------------- internal/web/templates.go | 12 ++++---- 3 files changed, 39 insertions(+), 30 deletions(-) diff --git a/conf/hydra-werther.conf b/conf/hydra-werther.conf index 54f69a3..f818785 100644 --- a/conf/hydra-werther.conf +++ b/conf/hydra-werther.conf @@ -116,4 +116,10 @@ WERTHER_LDAP_ROLE_BASEDN=ou=groups,dc=myorg,dc=com # [description] a base path of web pages # [type] String # [default] / + # [required] + +#WERTHER_LDAP_CONNECTION_TIMEOUT= + # [description] LDAP server connection timeout + # [type] Duration + # [default] 60s # [required] \ No newline at end of file diff --git a/internal/ldapclient/ldapclient.go b/internal/ldapclient/ldapclient.go index 05bcfb9..c115151 100644 --- a/internal/ldapclient/ldapclient.go +++ b/internal/ldapclient/ldapclient.go @@ -48,19 +48,20 @@ type connector interface { // Config is a LDAP configuration. type Config struct { - Endpoints []string `envconfig:"endpoints" required:"true" desc:"a LDAP's server URLs as \"
:\""` - BindDN string `envconfig:"binddn" desc:"a LDAP bind DN"` - BindPass string `envconfig:"bindpw" json:"-" desc:"a LDAP bind password"` - BaseDN string `envconfig:"basedn" required:"true" desc:"a LDAP base DN for searching users"` - UserSearchQuery string `envconfig:"user_search_query" desc:"the user search query" default:"(&(|(objectClass=organizationalPerson)(objectClass=inetOrgPerson))(|(uid=%[1]s)(mail=%[1]s)(userPrincipalName=%[1]s)(sAMAccountName=%[1]s)))"` - AttrClaims map[string]string `envconfig:"attr_claims" default:"name:name,sn:family_name,givenName:given_name,mail:email" desc:"a mapping of LDAP attributes to OpenID connect claims"` - RoleBaseDN string `envconfig:"role_basedn" required:"true" desc:"a LDAP base DN for searching roles"` - RoleSearchQuery string `envconfig:"role_search_query" desc:"the role search query" default:"(|(&(|(objectClass=group)(objectClass=groupOfNames))(member=%[1]s))(&(objectClass=groupOfUniqueNames)(uniqueMember=%[1]s)))"` - RoleAttr string `envconfig:"role_attr" default:"description" desc:"a LDAP group's attribute that contains a role's name"` - RoleClaim string `envconfig:"role_claim" default:"https://github.com/i-core/werther/claims/roles" desc:"a name of an OpenID Connect claim that contains user roles"` - CacheSize int `envconfig:"cache_size" default:"512" desc:"a user info cache's size in KiB"` - CacheTTL time.Duration `envconfig:"cache_ttl" default:"30m" desc:"a user info cache TTL"` - IsTLS bool `envconfig:"is_tls" default:"false" desc:"should LDAP connection be established via TLS"` + Endpoints []string `envconfig:"endpoints" required:"true" desc:"a LDAP's server URLs as \"
:\""` + BindDN string `envconfig:"binddn" desc:"a LDAP bind DN"` + BindPass string `envconfig:"bindpw" json:"-" desc:"a LDAP bind password"` + BaseDN string `envconfig:"basedn" required:"true" desc:"a LDAP base DN for searching users"` + UserSearchQuery string `envconfig:"user_search_query" desc:"the user search query" default:"(&(|(objectClass=organizationalPerson)(objectClass=inetOrgPerson))(|(uid=%[1]s)(mail=%[1]s)(userPrincipalName=%[1]s)(sAMAccountName=%[1]s)))"` + AttrClaims map[string]string `envconfig:"attr_claims" default:"name:name,sn:family_name,givenName:given_name,mail:email" desc:"a mapping of LDAP attributes to OpenID connect claims"` + RoleBaseDN string `envconfig:"role_basedn" required:"true" desc:"a LDAP base DN for searching roles"` + RoleSearchQuery string `envconfig:"role_search_query" desc:"the role search query" default:"(|(&(|(objectClass=group)(objectClass=groupOfNames))(member=%[1]s))(&(objectClass=groupOfUniqueNames)(uniqueMember=%[1]s)))"` + RoleAttr string `envconfig:"role_attr" default:"description" desc:"a LDAP group's attribute that contains a role's name"` + RoleClaim string `envconfig:"role_claim" default:"https://github.com/i-core/werther/claims/roles" desc:"a name of an OpenID Connect claim that contains user roles"` + CacheSize int `envconfig:"cache_size" default:"512" desc:"a user info cache's size in KiB"` + CacheTTL time.Duration `envconfig:"cache_ttl" default:"30m" desc:"a user info cache TTL"` + IsTLS bool `envconfig:"is_tls" default:"false" desc:"should LDAP connection be established via TLS"` + ConnectionTimeout time.Duration `envconfig:"connection_timeout" default:"60s" desc:"LDAP server connection timeout"` } // Client is a LDAP client (compatible with Active Directory). @@ -75,11 +76,12 @@ func New(cnf Config) *Client { return &Client{ Config: cnf, connector: &ldapConnector{ - BaseDN: cnf.BaseDN, - UserSearchQuery: cnf.UserSearchQuery, - RoleBaseDN: cnf.RoleBaseDN, - IsTLS: cnf.IsTLS, - RoleSearchQuery: cnf.RoleSearchQuery, + BaseDN: cnf.BaseDN, + UserSearchQuery: cnf.UserSearchQuery, + RoleBaseDN: cnf.RoleBaseDN, + IsTLS: cnf.IsTLS, + RoleSearchQuery: cnf.RoleSearchQuery, + ConnectionTimeout: cnf.ConnectionTimeout, }, cache: freecache.NewCache(cnf.CacheSize * 1024), } @@ -291,15 +293,16 @@ func (cli *Client) findBasicUserDetails(cn conn, username string, attrs []string } type ldapConnector struct { - BaseDN string - RoleBaseDN string - IsTLS bool - UserSearchQuery string - RoleSearchQuery string + BaseDN string + RoleBaseDN string + IsTLS bool + UserSearchQuery string + RoleSearchQuery string + ConnectionTimeout time.Duration } func (c *ldapConnector) Connect(ctx context.Context, addr string) (conn, error) { - d := net.Dialer{Timeout: ldap.DefaultTimeout} + d := net.Dialer{Timeout: c.ConnectionTimeout} tcpcn, err := d.DialContext(ctx, "tcp", addr) if err != nil { return nil, err diff --git a/internal/web/templates.go b/internal/web/templates.go index ce05875..7622422 100644 --- a/internal/web/templates.go +++ b/internal/web/templates.go @@ -89,7 +89,7 @@ func loginTmpl() (*asset, error) { return nil, err } - info := bindataFileInfo{name: "login.tmpl", size: 1376, mode: os.FileMode(0664), modTime: time.Unix(1598432745, 0)} + info := bindataFileInfo{name: "login.tmpl", size: 1376, mode: os.FileMode(0644), modTime: time.Unix(1632751659, 0)} a := &asset{bytes: bytes, info: info, digest: [32]uint8{0x96, 0x82, 0x4c, 0x6a, 0xc3, 0x92, 0x44, 0x14, 0x82, 0xe7, 0x9a, 0xa8, 0xc8, 0x81, 0x35, 0x91, 0x53, 0xa8, 0x9, 0xe5, 0x8, 0xd5, 0xf, 0x5c, 0x48, 0x31, 0xde, 0xbf, 0xb7, 0x65, 0x23, 0xa9}} return a, nil } @@ -109,7 +109,7 @@ func staticFontsRobotoLightTtf() (*asset, error) { return nil, err } - info := bindataFileInfo{name: "static/fonts/Roboto-Light.ttf", size: 170012, mode: os.FileMode(0644), modTime: time.Unix(1574945279, 0)} + info := bindataFileInfo{name: "static/fonts/Roboto-Light.ttf", size: 170012, mode: os.FileMode(0644), modTime: time.Unix(1631861563, 0)} a := &asset{bytes: bytes, info: info, digest: [32]uint8{0xdb, 0x2, 0x9, 0x6a, 0x91, 0xc2, 0xa, 0xb6, 0x2d, 0x45, 0x90, 0x1, 0xa1, 0x5, 0x9b, 0xc8, 0xd7, 0x8c, 0xaa, 0x35, 0xd6, 0x37, 0xdc, 0x91, 0x49, 0x4c, 0x44, 0x40, 0x81, 0x5a, 0x6a, 0xc1}} return a, nil } @@ -129,7 +129,7 @@ func staticFontsRobotoLightWoff() (*asset, error) { return nil, err } - info := bindataFileInfo{name: "static/fonts/Roboto-Light.woff", size: 93468, mode: os.FileMode(0644), modTime: time.Unix(1574945279, 0)} + info := bindataFileInfo{name: "static/fonts/Roboto-Light.woff", size: 93468, mode: os.FileMode(0644), modTime: time.Unix(1631861563, 0)} a := &asset{bytes: bytes, info: info, digest: [32]uint8{0x77, 0xad, 0xe0, 0x48, 0xda, 0x36, 0xf1, 0x3, 0xa5, 0x20, 0x45, 0x5a, 0xcb, 0xd2, 0xf, 0x26, 0xbd, 0x45, 0xd6, 0xf1, 0xc4, 0x21, 0x5, 0x4a, 0x5d, 0x92, 0x6f, 0x55, 0x65, 0x25, 0x16, 0x35}} return a, nil } @@ -149,7 +149,7 @@ func staticFontsRobotoLightWoff2() (*asset, error) { return nil, err } - info := bindataFileInfo{name: "static/fonts/Roboto-Light.woff2", size: 64272, mode: os.FileMode(0644), modTime: time.Unix(1574945279, 0)} + info := bindataFileInfo{name: "static/fonts/Roboto-Light.woff2", size: 64272, mode: os.FileMode(0644), modTime: time.Unix(1631861563, 0)} a := &asset{bytes: bytes, info: info, digest: [32]uint8{0x1a, 0x87, 0xc0, 0x97, 0xd1, 0xa3, 0x42, 0xec, 0x1b, 0x1a, 0x40, 0x6, 0x6d, 0x4d, 0xbe, 0x9d, 0x6f, 0x14, 0x49, 0x2d, 0x78, 0x80, 0x5d, 0xe2, 0xa1, 0xb5, 0x7d, 0xaf, 0x8b, 0x28, 0xd6, 0x40}} return a, nil } @@ -169,7 +169,7 @@ func staticScriptJs() (*asset, error) { return nil, err } - info := bindataFileInfo{name: "static/script.js", size: 1240, mode: os.FileMode(0644), modTime: time.Unix(1565090829, 0)} + info := bindataFileInfo{name: "static/script.js", size: 1240, mode: os.FileMode(0644), modTime: time.Unix(1631861563, 0)} a := &asset{bytes: bytes, info: info, digest: [32]uint8{0x21, 0x83, 0x40, 0xc4, 0xb1, 0x4e, 0x2c, 0xf8, 0x84, 0x11, 0x9b, 0x80, 0xc2, 0xe6, 0xab, 0xb5, 0xf8, 0xd5, 0x3b, 0xc9, 0x2e, 0x5b, 0x12, 0x7, 0x29, 0x2f, 0x21, 0x5f, 0x59, 0x35, 0xf7, 0xad}} return a, nil } @@ -189,7 +189,7 @@ func staticStyleCss() (*asset, error) { return nil, err } - info := bindataFileInfo{name: "static/style.css", size: 5966, mode: os.FileMode(0644), modTime: time.Unix(1574945279, 0)} + info := bindataFileInfo{name: "static/style.css", size: 5966, mode: os.FileMode(0644), modTime: time.Unix(1631861563, 0)} a := &asset{bytes: bytes, info: info, digest: [32]uint8{0xdf, 0x10, 0x89, 0x7e, 0x7, 0xd2, 0xf2, 0xcc, 0xa2, 0x4e, 0xcf, 0x1, 0x63, 0x75, 0x97, 0xa1, 0x1c, 0x36, 0x4e, 0x34, 0x44, 0x85, 0x53, 0x93, 0xd4, 0x40, 0x69, 0x5f, 0x78, 0x30, 0x17, 0x8f}} return a, nil }