keycloak

Documentation

Index

• Constants
• type Client
  • func NewClient(host, realm, username, password string) Client
  • func (c Client) DeleteGroup(ctx context.Context, path ...string) error
  • func (c Client) ListGroups(ctx context.Context) ([]Group, error)
  • func (c Client) PutGroup(ctx context.Context, group Group) (Group, error)
  • func (c Client) PutUser(ctx context.Context, user User) (User, error)
• type ErrEvent
• type GoCloak
• type Group
  • func NewGroup(displayName string, path ...string) Group
  • func NewGroupFromPath(displayName string, path string) Group
  • func (g Group) BaseName() string
  • func (g Group) Path() string
  • func (g Group) PathMembers() []string
  • func (g Group) WithMemberNames(members ...string) Group
• type MembershipSyncError
  • func (err MembershipSyncError) Error() string
  • func (err MembershipSyncError) Unwrap() error
• type MembershipSyncErrors
  • func (errs *MembershipSyncErrors) Error() string
• type User
  • func UserFromKeycloakUser(u gocloak.User) User
  • func (u User) ApplyTo(tu *gocloak.User)
  • func (u User) DisplayName() string
• type UserNotFoundError
  • func (err UserNotFoundError) Error() string
  • func (err UserNotFoundError) Is(target error) bool

Constants

const (
	// KeycloakDefaultOrganizationRef references the keycloak user attribute.
	// TODO(bastjan) If we add more attributes I'd use struct tags struct{ DefaultOrganizationRef string `kcattr:"appuio.io/default-organization"` }
	KeycloakDefaultOrganizationRef = "appuio.io/default-organization"
)

Types

type Client

type Client struct {
	Client GoCloak

	Host  string
	Realm string
	// LoginRealm is used for the client to authenticate against keycloak. If not set Realm is used.
	LoginRealm string
	Username   string
	Password   string

	// RootGroup, if set, transparently manages groups under given root group.
	// Searches and puts groups under the given root group and strips the root group from the return values.
	// The root group must exist in Keycloak.
	RootGroup string
}

Client interacts with the Keycloak API

func NewClient

func NewClient(host, realm, username, password string) Client

NewClient creates a new Client

func (Client) DeleteGroup

func (c Client) DeleteGroup(ctx context.Context, path ...string) error

DeleteGroup deletes the Keycloak group by name. The method is idempotent and will not do anything if the group does not exits.

func (Client) ListGroups

func (c Client) ListGroups(ctx context.Context) ([]Group, error)

ListGroups returns all top-level Keycloak groups in the realm and their direct children. More deeply nested children are not returned. This is potentially very expensive, as it needs to iterate over all groups to get their members and sub groups.

func (Client) PutGroup

func (c Client) PutGroup(ctx context.Context, group Group) (Group, error)

PutGroup creates the provided Keycloak group if it does not exist and adjusts the group members accordingly. The method is idempotent.

func (Client) PutUser

func (c Client) PutUser(ctx context.Context, user User) (User, error)

PutUser updates the given user referenced by its `Username` property. An error is returned if a user can't be found.

type ErrEvent

type ErrEvent string

ErrEvent is the reason this error was thrown. It should be short and unique, imagine people writing switch statements to handle them.

var UserAddError ErrEvent = "AddUserFailed"

UserAddError indicates that the client was unable to add the user to the group

var UserRemoveError ErrEvent = "RemoveUserFailed"

UserRemoveError indicates that the client was unable to remove the user from the group

type GoCloak

type GoCloak interface {
	LoginAdmin(ctx context.Context, username, password, realm string) (*gocloak.JWT, error)
	LogoutPublicClient(ctx context.Context, clientID, realm, accessToken, refreshToken string) error

	CreateGroup(ctx context.Context, accessToken, realm string, group gocloak.Group) (string, error)
	CreateChildGroup(ctx context.Context, accessToken, realm, groupID string, group gocloak.Group) (string, error)
	GetGroups(ctx context.Context, accessToken, realm string, params gocloak.GetGroupsParams) ([]*gocloak.Group, error)
	UpdateGroup(ctx context.Context, accessToken, realm string, updatedGroup gocloak.Group) error
	DeleteGroup(ctx context.Context, accessToken, realm, groupID string) error

	GetGroupMembers(ctx context.Context, accessToken, realm, groupID string, params gocloak.GetGroupsParams) ([]*gocloak.User, error)
	GetUsers(ctx context.Context, accessToken, realm string, params gocloak.GetUsersParams) ([]*gocloak.User, error)
	UpdateUser(ctx context.Context, accessToken, realm string, user gocloak.User) error
	AddUserToGroup(ctx context.Context, token, realm, userID, groupID string) error
	DeleteUserFromGroup(ctx context.Context, token, realm, userID, groupID string) error
	GetServerInfo(ctx context.Context, accessToken string) (*gocloak.ServerInfoRepresentation, error)

	GetRequestWithBearerAuth(ctx context.Context, token string) *resty.Request
}

GoCloak is the subset of methods of the humongous gocloak.GoCloak interface that we actually need. This keeps the mock at a more reasonable size

type Group

type Group struct {
	Members []User
	// contains filtered or unexported fields
}

Group is a representation of a group in keycloak

func NewGroup

func NewGroup(displayName string, path ...string) Group

NewGroup creates a new group.

func NewGroupFromPath

func NewGroupFromPath(displayName string, path string) Group

NewGroupFromPath creates a new group.

func (Group) BaseName

func (g Group) BaseName() string

BaseName returns the name of the group.

func (Group) Path

func (g Group) Path() string

Path returns the path of the group.

func (Group) PathMembers

func (g Group) PathMembers() []string

PathMembers returns the split path of the group.

func (Group) WithMemberNames

func (g Group) WithMemberNames(members ...string) Group

WithMemberNames returns a copy of the group with given members added.

type MembershipSyncError

type MembershipSyncError struct {
	Err      error
	Username string
	Event    ErrEvent
}

MembershipSyncError is a custom error indicating the failure of syncing the membership of a single user.

func (MembershipSyncError) Error

func (err MembershipSyncError) Error() string

func (MembershipSyncError) Unwrap

func (err MembershipSyncError) Unwrap() error

type MembershipSyncErrors

type MembershipSyncErrors []MembershipSyncError

MembershipSyncErrors is a cusom error that can be used to indicate that the client failed to sync one or more memberships.

func (*MembershipSyncErrors) Error

func (errs *MembershipSyncErrors) Error() string

type User

type User struct {
	ID string
	// Username is the .metadata.name in kubernetes and the .Username field in Keycloak
	Username string

	Email     string
	FirstName string
	LastName  string

	DefaultOrganizationRef string
}

User is a representation of a user in keycloak

func UserFromKeycloakUser

func UserFromKeycloakUser(u gocloak.User) User

UserFromKeycloakUser returns a user with attributes mapped from the given keycloak user

func (User) ApplyTo

func (u User) ApplyTo(tu *gocloak.User)

ApplyTo sets attributes from this user to the given gocloak.User

func (User) DisplayName

func (u User) DisplayName() string

DisplayName returns the disply name of this user

type UserNotFoundError

type UserNotFoundError struct {
	Username string
}

UserNotFoundError indicates a user could not be found.

func (UserNotFoundError) Error

func (err UserNotFoundError) Error() string

func (UserNotFoundError) Is

func (err UserNotFoundError) Is(target error) bool