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.

Sign up for GitHub

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

GH-238 Added 'default_signature_algorithm' to Realm config #282

Merged
merged 2 commits into from
Jun 28, 2020
Merged

GH-238 Added 'default_signature_algorithm' to Realm config #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a041a9
GH-238 Added 'default_signature_algorithm' to Realm config
May 8, 2020
692ffcc
Merge branch 'master' into GH-238
mrparkers Jun 28, 2020
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/resources/keycloak_realm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ If any of these attributes are not specified, they will default to Keycloak's de

The following attributes can be found in the "Tokens" tab within the realm settings.

- `default_signature_algorithm` - (Optional) Default algorithm used to sign tokens for the realm.
- `revoke_refresh_token` - (Optional) If enabled a refresh token can only be used number of times specified in 'refresh_token_max_reuse' before they are revoked. If unspecified, refresh tokens can be reused.
- `refresh_token_max_reuse` - (Optional) Maximum number of times a refresh token can be reused before they are revoked. If unspecified and 'revoke_refresh_token' is enabled the default value is 0 and refresh tokens can not be reused.

Expand Down
27 changes: 14 additions & 13 deletions keycloak/realm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,20 @@ type Realm struct {
EmailTheme string `json:"emailTheme,omitempty"`

// Tokens
RevokeRefreshToken bool `json:"revokeRefreshToken"`
RefreshTokenMaxReuse int `json:"refreshTokenMaxReuse"`
SsoSessionIdleTimeout int `json:"ssoSessionIdleTimeout,omitempty"`
SsoSessionMaxLifespan int `json:"ssoSessionMaxLifespan,omitempty"`
OfflineSessionIdleTimeout int `json:"offlineSessionIdleTimeout,omitempty"`
OfflineSessionMaxLifespan int `json:"offlineSessionMaxLifespan,omitempty"`
AccessTokenLifespan int `json:"accessTokenLifespan,omitempty"`
AccessTokenLifespanForImplicitFlow int `json:"accessTokenLifespanForImplicitFlow,omitempty"`
AccessCodeLifespan int `json:"accessCodeLifespan,omitempty"`
AccessCodeLifespanLogin int `json:"accessCodeLifespanLogin,omitempty"`
AccessCodeLifespanUserAction int `json:"accessCodeLifespanUserAction,omitempty"`
ActionTokenGeneratedByUserLifespan int `json:"actionTokenGeneratedByUserLifespan,omitempty"`
ActionTokenGeneratedByAdminLifespan int `json:"actionTokenGeneratedByAdminLifespan,omitempty"`
DefaultSignatureAlgorithm string `json:"defaultSignatureAlgorithm"`
RevokeRefreshToken bool `json:"revokeRefreshToken"`
RefreshTokenMaxReuse int `json:"refreshTokenMaxReuse"`
SsoSessionIdleTimeout int `json:"ssoSessionIdleTimeout,omitempty"`
SsoSessionMaxLifespan int `json:"ssoSessionMaxLifespan,omitempty"`
OfflineSessionIdleTimeout int `json:"offlineSessionIdleTimeout,omitempty"`
OfflineSessionMaxLifespan int `json:"offlineSessionMaxLifespan,omitempty"`
AccessTokenLifespan int `json:"accessTokenLifespan,omitempty"`
AccessTokenLifespanForImplicitFlow int `json:"accessTokenLifespanForImplicitFlow,omitempty"`
AccessCodeLifespan int `json:"accessCodeLifespan,omitempty"`
AccessCodeLifespanLogin int `json:"accessCodeLifespanLogin,omitempty"`
AccessCodeLifespanUserAction int `json:"accessCodeLifespanUserAction,omitempty"`
ActionTokenGeneratedByUserLifespan int `json:"actionTokenGeneratedByUserLifespan,omitempty"`
ActionTokenGeneratedByAdminLifespan int `json:"actionTokenGeneratedByAdminLifespan,omitempty"`

//internationalization
InternationalizationEnabled bool `json:"internationalizationEnabled"`
Expand Down
10 changes: 10 additions & 0 deletions provider/resource_keycloak_realm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,10 @@ func resourceKeycloakRealm() *schema.Resource {
},

// Tokens
"default_signature_algorithm": {
Type: schema.TypeString,
Optional: true,
},
"revoke_refresh_token": {
Type: schema.TypeBool,
Optional: true,
Expand Down Expand Up @@ -538,6 +542,11 @@ func getRealmFromData(data *schema.ResourceData) (*keycloak.Realm, error) {
}

// Tokens

if defaultSignatureAlgorithm, ok := data.GetOk("default_signature_algorithm"); ok {
realm.DefaultSignatureAlgorithm = defaultSignatureAlgorithm.(string)
}

if revokeRefreshToken, ok := data.GetOk("revoke_refresh_token"); ok {
realm.RevokeRefreshToken = revokeRefreshToken.(bool)
}
Expand Down Expand Up @@ -794,6 +803,7 @@ func setRealmData(data *schema.ResourceData, realm *keycloak.Realm) {
data.Set("email_theme", realm.EmailTheme)

// Tokens
data.Set("default_signature_algorithm", realm.DefaultSignatureAlgorithm)
data.Set("revoke_refresh_token", realm.RevokeRefreshToken)
data.Set("refresh_token_max_reuse", realm.RefreshTokenMaxReuse)
data.Set("sso_session_idle_timeout", getDurationStringFromSeconds(realm.SsoSessionIdleTimeout))
Expand Down
4 changes: 3 additions & 1 deletion provider/resource_keycloak_realm_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1238,6 +1238,7 @@ resource "keycloak_realm" "realm" {
}

func testKeycloakRealm_tokenSettings(realm string) string {
defaultSignatureAlgorithm := "RS256"
ssoSessionIdleTimeout := randomDurationString()
ssoSessionMaxLifespan := randomDurationString()
offlineSessionIdleTimeout := randomDurationString()
Expand All @@ -1256,6 +1257,7 @@ resource "keycloak_realm" "realm" {
enabled = true
display_name = "%s"

default_signature_algorithm = "%s"
sso_session_idle_timeout = "%s"
sso_session_max_lifespan = "%s"
offline_session_idle_timeout = "%s"
Expand All @@ -1268,7 +1270,7 @@ resource "keycloak_realm" "realm" {
action_token_generated_by_user_lifespan = "%s"
action_token_generated_by_admin_lifespan = "%s"
}
`, realm, realm, ssoSessionIdleTimeout, ssoSessionMaxLifespan, offlineSessionIdleTimeout, offlineSessionMaxLifespan, accessTokenLifespan, accessTokenLifespanForImplicitFlow, accessCodeLifespan, accessCodeLifespanLogin, accessCodeLifespanUserAction, actionTokenGeneratedByUserLifespan, actionTokenGeneratedByAdminLifespan)
`, realm, realm, defaultSignatureAlgorithm, ssoSessionIdleTimeout, ssoSessionMaxLifespan, offlineSessionIdleTimeout, offlineSessionMaxLifespan, accessTokenLifespan, accessTokenLifespanForImplicitFlow, accessCodeLifespan, accessCodeLifespanLogin, accessCodeLifespanUserAction, actionTokenGeneratedByUserLifespan, actionTokenGeneratedByAdminLifespan)
}

func testKeycloakRealm_securityDefensesHeaders(realm, realmDisplayName, xFrameOptions string) string {
Expand Down