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

Add reconciliation of authorization services in KeycloakClients #12

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+723 −5
Open

Add reconciliation of authorization services in KeycloakClients #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ setup/linter:
code/run:
@operator-sdk run local --watch-namespace=${NAMESPACE}

.PHONY: code/run-debug
code/run-debug:
@operator-sdk run local --enable-delve --watch-namespace=${NAMESPACE}

.PHONY: code/run-as-container
code/run-as-container: code/delete-container
eval $$(minikube -p minikube docker-env); \
Expand Down
137 changes: 135 additions & 2 deletions pkg/common/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ import (
)

const (
authURL = "realms/master/protocol/openid-connect/token"
authURL = "realms/master/protocol/openid-connect/token"
clientAuthorizationResourceResourceName = "client authorization service => resource"
clientAuthorizationPolicyResourceName = "client authorization service => policy"
)

type Requester interface {
Expand Down Expand Up @@ -78,6 +80,28 @@ func (c *Client) create(obj T, resourcePath, resourceName string) (string, error
fmt.Println("user response ", string(d))
}

// Endpoint for creating authorization resources does not return an ID in Header "Location", but a JSON
// of the created resource instead. We need to parse it and then return its ID.
if resourceName == clientAuthorizationResourceResourceName {
var resource v1alpha1.KeycloakResource
data, _ := ioutil.ReadAll(res.Body)
err := json.Unmarshal(data, &resource)
if err != nil {
return "", err
}
return resource.ID, nil
}

if resourceName == clientAuthorizationPolicyResourceName {
var policy v1alpha1.KeycloakPolicy
data, _ := ioutil.ReadAll(res.Body)
err := json.Unmarshal(data, &policy)
if err != nil {
return "", err
}
return policy.ID, nil
}

location := strings.Split(res.Header.Get("Location"), "/")
uid := location[len(location)-1]
return uid, nil
Expand Down Expand Up @@ -114,6 +138,103 @@ func (c *Client) CreateClientClientScopeMappings(specClient *v1alpha1.KeycloakAP
return err
}

func (c *Client) ListClientAuthorizationResources(clientID, realmName string) ([]v1alpha1.KeycloakResource, error) {
result, err := c.list(
fmt.Sprintf("realms/%s/clients/%s/authz/resource-server/resource", realmName, clientID),
clientAuthorizationResourceResourceName,
func(body []byte) (T, error) {
var resources []v1alpha1.KeycloakResource
err := json.Unmarshal(body, &resources)
return resources, err
},
)

if err != nil {
return nil, err
}

res, ok := result.([]v1alpha1.KeycloakResource)

if !ok {
return nil, errors.Errorf("error decoding list client authorization service => resources")
}

return res, nil
}

func (c *Client) CreateClientAuthorizationResource(specClient *v1alpha1.KeycloakAPIClient, specResource *v1alpha1.KeycloakResource, realmName string) (string, error) {
return c.create(
specResource,
fmt.Sprintf("realms/%s/clients/%s/authz/resource-server/resource", realmName, specClient.ID),
clientAuthorizationResourceResourceName,
)
}

func (c *Client) UpdateClientAuthorizationResource(specClient *v1alpha1.KeycloakAPIClient, newResource *v1alpha1.KeycloakResource, oldResource *v1alpha1.KeycloakResource, realmName string) error {
return c.update(
newResource,
fmt.Sprintf("realms/%s/clients/%s/authz/resource-server/resource/%s", realmName, specClient.ID, oldResource.ID),
clientAuthorizationResourceResourceName,
)
}

func (c *Client) DeleteClientAuthorizationResource(specClient *v1alpha1.KeycloakAPIClient, specResource *v1alpha1.KeycloakResource, realmName string) error {
return c.delete(
fmt.Sprintf("realms/%s/clients/%s/authz/resource-server/resource/%s", realmName, specClient.ID, specResource.ID),
clientAuthorizationResourceResourceName,
nil,
)
}

func (c *Client) ListClientAuthorizationPolicies(clientID, realmName string) ([]v1alpha1.KeycloakPolicy, error) {
result, err := c.list(
fmt.Sprintf("realms/%s/clients/%s/authz/resource-server/policy", realmName, clientID),
clientAuthorizationPolicyResourceName,
func(body []byte) (T, error) {
var policies []v1alpha1.KeycloakPolicy
err := json.Unmarshal(body, &policies)
return policies, err
},
)

if err != nil {
return nil, err
}

res, ok := result.([]v1alpha1.KeycloakPolicy)

if !ok {
return nil, errors.Errorf("error decoding list client authorization service => policies")
}

return res, nil
}

func (c *Client) CreateClientAuthorizationPolicy(specClient *v1alpha1.KeycloakAPIClient, specPolicy *v1alpha1.KeycloakPolicy, realmName string) (string, error) {
return c.create(
specPolicy,
fmt.Sprintf("realms/%s/clients/%s/authz/resource-server/policy", realmName, specClient.ID),
clientAuthorizationPolicyResourceName,
)
}

func (c *Client) UpdateClientAuthorizationPolicy(specClient *v1alpha1.KeycloakAPIClient, newPolicy *v1alpha1.KeycloakPolicy, oldPolicy *v1alpha1.KeycloakPolicy, realmName string) error {
return c.update(
newPolicy,
fmt.Sprintf("realms/%s/clients/%s/authz/resource-server/policy/%s", realmName, specClient.ID,
oldPolicy.ID),
clientAuthorizationPolicyResourceName,
)
}

func (c *Client) DeleteClientAuthorizationPolicy(specClient *v1alpha1.KeycloakAPIClient, specPolicy *v1alpha1.KeycloakPolicy, realmName string) error {
return c.delete(
fmt.Sprintf("realms/%s/clients/%s/authz/resource-server/policy/%s", realmName, specClient.ID, specPolicy.ID),
clientAuthorizationPolicyResourceName,
nil,
)
}

func (c *Client) CreateUser(user *v1alpha1.KeycloakAPIUser, realmName string) (string, error) {
return c.create(user, fmt.Sprintf("realms/%s/users", realmName), "user")
}
Expand Down Expand Up @@ -963,6 +1084,18 @@ type KeycloakInterface interface {
UpdateClientOptionalClientScope(specClient *v1alpha1.KeycloakAPIClient, clientScope *v1alpha1.KeycloakClientScope, realmName string) error
DeleteClientOptionalClientScope(specClient *v1alpha1.KeycloakAPIClient, clientScope *v1alpha1.KeycloakClientScope, realmName string) error

ListClientAuthorizationResources(clientID, realmName string) ([]v1alpha1.KeycloakResource, error)
CreateClientAuthorizationResource(specClient *v1alpha1.KeycloakAPIClient, specResource *v1alpha1.KeycloakResource, realmName string) (string, error)
UpdateClientAuthorizationResource(specClient *v1alpha1.KeycloakAPIClient, newResource *v1alpha1.KeycloakResource, oldResource *v1alpha1.KeycloakResource, realmName string) error
DeleteClientAuthorizationResource(specClient *v1alpha1.KeycloakAPIClient, specResource *v1alpha1.KeycloakResource, realmName string) error

// TODO implement API for updating authorization scopes?

ListClientAuthorizationPolicies(clientID, realmName string) ([]v1alpha1.KeycloakPolicy, error)
CreateClientAuthorizationPolicy(specClient *v1alpha1.KeycloakAPIClient, specPolicy *v1alpha1.KeycloakPolicy, realmName string) (string, error)
UpdateClientAuthorizationPolicy(specClient *v1alpha1.KeycloakAPIClient, newPolicy *v1alpha1.KeycloakPolicy, oldPolicy *v1alpha1.KeycloakPolicy, realmName string) error
DeleteClientAuthorizationPolicy(specClient *v1alpha1.KeycloakAPIClient, specPolicy *v1alpha1.KeycloakPolicy, realmName string) error

CreateUser(user *v1alpha1.KeycloakAPIUser, realmName string) (string, error)
CreateFederatedIdentity(fid v1alpha1.FederatedIdentity, userID string, realmName string) (string, error)
RemoveFederatedIdentity(fid v1alpha1.FederatedIdentity, userID string, realmName string) error
Expand Down Expand Up @@ -1006,7 +1139,7 @@ var _ KeycloakInterface = &Client{}

//go:generate moq -out keycloakClientFactory_moq.go . KeycloakClientFactory

//KeycloakClientFactory interface
// KeycloakClientFactory interface
type KeycloakClientFactory interface {
AuthenticatedClient(kc v1alpha1.ExternalKeycloak) (KeycloakInterface, error)
}
Expand Down
17 changes: 17 additions & 0 deletions pkg/common/client_state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ type ClientState struct {
DeprecatedClientSecret *v1.Secret // keycloak-client-secret-<clientID>
Keycloak kc.ExternalKeycloak
ServiceAccountUserState *UserState
AuthorizationPolicies []kc.KeycloakPolicy
AuthorizationResources []kc.KeycloakResource
AuthorizationScopes []kc.KeycloakScope
}

func NewClientState(context context.Context, realm *kc.KeycloakRealm, keycloak kc.ExternalKeycloak) *ClientState {
Expand Down Expand Up @@ -96,6 +99,20 @@ func (i *ClientState) Read(context context.Context, cr *kc.KeycloakClient, realm
return err
}

if i.Client.AuthorizationServicesEnabled {
i.AuthorizationResources, err = realmClient.ListClientAuthorizationResources(cr.Spec.Client.ID, i.Realm.Spec.Realm.Realm)
if err != nil {
return err
}

i.AuthorizationPolicies, err = realmClient.ListClientAuthorizationPolicies(cr.Spec.Client.ID, i.Realm.Spec.Realm.Realm)
if err != nil {
return err
}

// TODO implement API for updating authorization scopes?
}

if i.Client.ServiceAccountsEnabled {
user, err := realmClient.GetServiceAccountUser(i.Realm.Spec.Realm.Realm, cr.Spec.Client.ID)
if err != nil {
Expand Down
Loading