Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added ldap_user_federation attribute trust_email #267

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs-old/resources/keycloak_ldap_user_federation.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ The following arguments are supported:
- `ONE_LEVEL`: Only search for users in the DN specified by `user_dn`.
- `SUBTREE`: Search entire LDAP subtree.
- `validate_password_policy` - (Optional) When `true`, Keycloak will validate passwords using the realm policy before updating it.
- `trust_email` - (Optional) If enabled, email provided by this provider is not verified even if verification is enabled for the realm.
- `use_truststore_spi` - (Optional) Can be one of `ALWAYS`, `ONLY_FOR_LDAPS`, or `NEVER`:
- `ALWAYS` - Always use the truststore SPI for LDAP connections.
- `NEVER` - Never use the truststore SPI for LDAP connections.
Expand Down
10 changes: 10 additions & 0 deletions keycloak/ldap_user_federation.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ type LdapUserFederation struct {
SearchScope string // api expects "1" or "2", but that means "One Level" or "Subtree"

ValidatePasswordPolicy bool
TrustEmail bool
UseTruststoreSpi string // can be "ldapsOnly", "always", or "never"
ConnectionTimeout string // duration string (ex: 1h30m)
ReadTimeout string // duration string (ex: 1h30m)
Expand Down Expand Up @@ -100,6 +101,9 @@ func convertFromLdapUserFederationToComponent(ldap *LdapUserFederation) (*compon
"validatePasswordPolicy": {
strconv.FormatBool(ldap.ValidatePasswordPolicy),
},
"trustEmail": {
strconv.FormatBool(ldap.TrustEmail),
},
"pagination": {
strconv.FormatBool(ldap.Pagination),
},
Expand Down Expand Up @@ -240,6 +244,11 @@ func convertFromComponentToLdapUserFederation(component *component) (*LdapUserFe
return nil, err
}

trustEmail, err := parseBoolAndTreatEmptyStringAsFalse(component.getConfig("trustEmail"))
if err != nil {
return nil, err
}

pagination, err := parseBoolAndTreatEmptyStringAsFalse(component.getConfig("pagination"))
if err != nil {
return nil, err
Expand Down Expand Up @@ -295,6 +304,7 @@ func convertFromComponentToLdapUserFederation(component *component) (*LdapUserFe
SearchScope: component.getConfig("searchScope"),

ValidatePasswordPolicy: validatePasswordPolicy,
TrustEmail: trustEmail,
UseTruststoreSpi: component.getConfig("useTruststoreSpi"),
Pagination: pagination,

Expand Down
8 changes: 8 additions & 0 deletions provider/resource_keycloak_ldap_user_federation.go
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,12 @@ func resourceKeycloakLdapUserFederation() *schema.Resource {
Default: false,
Description: "When true, Keycloak will validate passwords using the realm policy before updating it.",
},
"trust_email": {
Type: schema.TypeBool,
Optional: true,
Default: false,
Description: "If enabled, email provided by this provider is not verified even if verification is enabled for the realm.",
},
"use_truststore_spi": {
Type: schema.TypeString,
Optional: true,
Expand Down Expand Up @@ -323,6 +329,7 @@ func getLdapUserFederationFromData(data *schema.ResourceData) *keycloak.LdapUser
SearchScope: data.Get("search_scope").(string),

ValidatePasswordPolicy: data.Get("validate_password_policy").(bool),
TrustEmail: data.Get("trust_email").(bool),
UseTruststoreSpi: data.Get("use_truststore_spi").(string),
ConnectionTimeout: data.Get("connection_timeout").(string),
ReadTimeout: data.Get("read_timeout").(string),
Expand Down Expand Up @@ -393,6 +400,7 @@ func setLdapUserFederationData(data *schema.ResourceData, ldap *keycloak.LdapUse
data.Set("search_scope", ldap.SearchScope)

data.Set("validate_password_policy", ldap.ValidatePasswordPolicy)
data.Set("trust_email", ldap.TrustEmail)
data.Set("use_truststore_spi", ldap.UseTruststoreSpi)
data.Set("connection_timeout", ldap.ConnectionTimeout)
data.Set("read_timeout", ldap.ReadTimeout)
Expand Down
8 changes: 7 additions & 1 deletion provider/resource_keycloak_ldap_user_federation_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,9 @@ func TestAccKeycloakLdapUserFederation_basicUpdateAll(t *testing.T) {
firstValidatePasswordPolicy := randomBool()
firstPagination := randomBool()

firstTrustEmail := randomBool()
secondTrustEmail := !firstTrustEmail

firstConnectionTimeout, _ := keycloak.GetDurationStringFromMilliseconds(strconv.Itoa(acctest.RandIntRange(1, 3600) * 1000))
secondConnectionTimeout, _ := keycloak.GetDurationStringFromMilliseconds(strconv.Itoa(acctest.RandIntRange(1, 3600) * 1000))
firstReadTimeout, _ := keycloak.GetDurationStringFromMilliseconds(strconv.Itoa(acctest.RandIntRange(1, 3600) * 1000))
Expand All @@ -247,6 +250,7 @@ func TestAccKeycloakLdapUserFederation_basicUpdateAll(t *testing.T) {
BindCredential: acctest.RandString(10),
SearchScope: randomStringInSlice([]string{"ONE_LEVEL", "SUBTREE"}),
ValidatePasswordPolicy: firstValidatePasswordPolicy,
TrustEmail: firstTrustEmail,
UseTruststoreSpi: randomStringInSlice([]string{"ALWAYS", "ONLY_FOR_LDAPS", "NEVER"}),
ConnectionTimeout: firstConnectionTimeout,
ReadTimeout: firstReadTimeout,
Expand Down Expand Up @@ -282,6 +286,7 @@ func TestAccKeycloakLdapUserFederation_basicUpdateAll(t *testing.T) {
BindCredential: acctest.RandString(10),
SearchScope: randomStringInSlice([]string{"ONE_LEVEL", "SUBTREE"}),
ValidatePasswordPolicy: !firstValidatePasswordPolicy,
TrustEmail: secondTrustEmail,
UseTruststoreSpi: randomStringInSlice([]string{"ALWAYS", "ONLY_FOR_LDAPS", "NEVER"}),
ConnectionTimeout: secondConnectionTimeout,
ReadTimeout: secondReadTimeout,
Expand Down Expand Up @@ -659,6 +664,7 @@ resource "keycloak_ldap_user_federation" "openldap" {
search_scope = "%s"

validate_password_policy = %t
trust_email = %t
use_truststore_spi = "%s"
connection_timeout = "%s"
read_timeout = "%s"
Expand All @@ -683,7 +689,7 @@ resource "keycloak_ldap_user_federation" "openldap" {
eviction_minute = %d
}
}
`, testAccRealmUserFederation.Realm, ldap.Name, ldap.Enabled, ldap.UsernameLDAPAttribute, ldap.RdnLDAPAttribute, ldap.UuidLDAPAttribute, arrayOfStringsForTerraformResource(ldap.UserObjectClasses), ldap.ConnectionUrl, ldap.UsersDn, ldap.BindDn, ldap.BindCredential, ldap.SearchScope, ldap.ValidatePasswordPolicy, ldap.UseTruststoreSpi, ldap.ConnectionTimeout, ldap.ReadTimeout, ldap.Pagination, ldap.BatchSizeForSync, ldap.FullSyncPeriod, ldap.ChangedSyncPeriod, ldap.ServerPrincipal, ldap.UseKerberosForPasswordAuthentication, ldap.KeyTab, ldap.KerberosRealm, ldap.CachePolicy, ldap.MaxLifespan, *ldap.EvictionDay, *ldap.EvictionHour, *ldap.EvictionMinute)
`, testAccRealmUserFederation.Realm, ldap.Name, ldap.Enabled, ldap.UsernameLDAPAttribute, ldap.RdnLDAPAttribute, ldap.UuidLDAPAttribute, arrayOfStringsForTerraformResource(ldap.UserObjectClasses), ldap.ConnectionUrl, ldap.UsersDn, ldap.BindDn, ldap.BindCredential, ldap.SearchScope, ldap.ValidatePasswordPolicy, ldap.TrustEmail, ldap.UseTruststoreSpi, ldap.ConnectionTimeout, ldap.ReadTimeout, ldap.Pagination, ldap.BatchSizeForSync, ldap.FullSyncPeriod, ldap.ChangedSyncPeriod, ldap.ServerPrincipal, ldap.UseKerberosForPasswordAuthentication, ldap.KeyTab, ldap.KerberosRealm, ldap.CachePolicy, ldap.MaxLifespan, *ldap.EvictionDay, *ldap.EvictionHour, *ldap.EvictionMinute)
}

func testKeycloakLdapUserFederation_basicWithAttrValidation(attr, ldap, val string) string {
Expand Down