gocloaksession

README

gocloaksession

This client is uses: gocloak and resty

Installation

go get github.com/Clarilab/gocloaksession

Importing

import "github.com/Clarilab/gocloaksession"

Features

// GoCloakSession holds all callable methods
type GoCloakSession interface {
	// GetKeycloakAuthToken returns a JWT object, containing the AccessToken and more
	GetKeycloakAuthToken() (*gocloak.JWT, error)

	// Sets the Authentication Header for the response
	// Can be used as Middleware in resty
	AddAuthTokenToRequest(*resty.Client, *resty.Request) error

	// GetGoCloakInstance returns the currently used GoCloak instance.
	GetGoCloakInstance() *gocloak.GoCloak
}

See https://github.com/Nerzal/gocloak/blob/master/token.go for complete JWT struct.

Example

// Create a new session
session := NewSession(clientId, clientSecret, realm, uri)

// Authenticate or refresh the token
token, err := session.GetKeycloakAuthToken()

If you want to use it as middleware in resty, you can use the following example

session := NewSession(clientId, clientSecret, realm, uri)

restyClient.OnBeforeRequest(session.AddAuthTokenToRequest)

In case you need the GoCloak instance to execute your own commands.

gocloakInstance := session.GetGoCloakInstance()

Developing & Testing

For local testing you need to start a docker container. Simply run following commands prior to starting the tests:

docker pull quay.io/keycloak/keycloak
docker run -d \
	-e KEYCLOAK_USER=admin \
	-e KEYCLOAK_PASSWORD=secret \
	-e KEYCLOAK_IMPORT=/tmp/gocloak-realm.json \
	-v "`pwd`/testdata/gocloak-realm.json:/tmp/gocloak-realm.json" \
	-p 8080:8080 \
	--name gocloak-test \
	quay.io/keycloak/keycloak:latest -Dkeycloak.profile.feature.upload_scripts=enabled

go test

To remove running docker container after completion of tests:

docker stop gocloak-test
docker rm gocloak-test

Documentation

Index

• type CallOption
  • func RequestSkipperCallOption(requestSkipper RequestSkipper) CallOption
• type GoCloakSession
  • func NewSession(clientID, clientSecret, realm, uri string, calloptions ...CallOption) (GoCloakSession, error)
• type RequestSkipper
  • func SubstringRequestSkipper(substr string) RequestSkipper

Types

type CallOption

type CallOption func(*goCloakSession) error

CallOption configures a Session

func RequestSkipperCallOption

func RequestSkipperCallOption(requestSkipper RequestSkipper) CallOption

RequestSkipperCallOption appends a RequestSkipper to the skipConditions

type GoCloakSession

type GoCloakSession interface {
	// GetKeycloakAuthToken returns a JWT object, containing the AccessToken and more
	GetKeycloakAuthToken() (*gocloak.JWT, error)

	// AddAuthTokenToRequest sets the Authentication Header for the response
	AddAuthTokenToRequest(*resty.Client, *resty.Request) error

	// GetGoCloakInstance returns the currently used GoCloak instance.
	GetGoCloakInstance() *gocloak.GoCloak

	// ForceRefresh returns the currently used GoCloak instance.
	ForceRefresh() error
}

GoCloakSession holds all callable methods

func NewSession

func NewSession(clientID, clientSecret, realm, uri string, calloptions ...CallOption) (GoCloakSession, error)

NewSession returns a new instance of a gocloak Session

type RequestSkipper

type RequestSkipper func(*resty.Request) bool

RequestSkipper is a function signature that can be used to skip a certain request if needed.

func SubstringRequestSkipper

func SubstringRequestSkipper(substr string) RequestSkipper

SubstringRequestSkipper is a RequestSkipper that skips a request when the url in the request contains a certain substring