authorization/org.modelix.authorization

Package-level declarations

Types

AccessTokenPrincipal

class AccessTokenPrincipal(val jwt: DecodedJWT) : Principal

EPermissionType

enum EPermissionType : Enum<EPermissionType>

IModelixAuthorizationConfig

interface IModelixAuthorizationConfig

Reduced interface exposed to users of the plugin.

KeycloakResource

data class KeycloakResource(val name: String, val type: KeycloakResourceType)

KeycloakResourceType

data class KeycloakResourceType(val name: String, val scopes: Set<KeycloakScope>, val createByUser: Boolean = false)

data class KeycloakScope(val name: String)

object ~~KeycloakUtils~~

ModelixAuthorization

object ModelixAuthorization : BaseRouteScopedPlugin<IModelixAuthorizationConfig, ModelixAuthorizationPluginInstance>

JWT based authorization plugin.

ModelixAuthorizationConfig

class ModelixAuthorizationConfig : IModelixAuthorizationConfig

ModelixAuthorizationPluginInstance

class ModelixAuthorizationPluginInstance(val config: ModelixAuthorizationConfig)

NoPermissionException

class NoPermissionException(val user: AccessTokenPrincipal?, val resourceId: String?, val scope: String?, message: String) : RuntimeException

NotLoggedInException

class NotLoggedInException : RuntimeException

UnknownPermissionException

class UnknownPermissionException(val permissionId: String, val unknownElement: String?, cause: Exception? = null) : Exception

Properties

serviceAccountTokenProvider

val serviceAccountTokenProvider: () -> String

Functions

fun String.asResource(): KeycloakResource

buildPermissionPage

fun HTML.buildPermissionPage(evaluator: PermissionEvaluator)

fun HTML.buildPermissionPage(schemaInstance: SchemaInstance)

checkPermission

fun ApplicationCall.checkPermission(permissionToCheck: PermissionParts)

fun PipelineContext<*, ApplicationCall>.checkPermission(permissionParts: PermissionParts)

fun ApplicationCall.checkPermission(resource: KeycloakResource, scope: KeycloakScope)

createModelixAccessToken

fun createModelixAccessToken(algorithm: Algorithm, user: String, grantedPermissions: List<String>, additionalTokenContent: (JWTCreator.Builder) -> Unit = {}): String

Creates a valid JWT token that is compatible to servers with the ModelixAuthorization plugin installed.

fun createModelixAccessToken(hmac512key: String, user: String, grantedPermissions: List<String>, additionalTokenContent: (JWTCreator.Builder) -> Unit = {}): String

fun ApplicationCall.getBearerToken(): String?

getModelixAuthorizationConfig

fun Application.getModelixAuthorizationConfig(): ModelixAuthorizationConfig

getPermissionEvaluator

fun ApplicationCall.getPermissionEvaluator(): PermissionEvaluator

fun ApplicationCall.getUserName(): String?

fun PipelineContext<Unit, ApplicationCall>.getUserName(): String?

fun ApplicationCall.hasPermission(permissionToCheck: PermissionParts): Boolean

installAuthentication

fun Application.~~installAuthentication~~(unitTestMode: Boolean = false)

fun ApplicationCall.jwt(): DecodedJWT?

fun ApplicationCall.jwtFromHeaders(): DecodedJWT?

fun DecodedJWT.~~nullIfInvalid~~(): DecodedJWT?

fun Route.requiresDelete(resource: KeycloakResource, body: Route.() -> Unit)

fun Route.requiresLogin(body: Route.() -> Unit)

requiresPermission

fun Route.requiresPermission(resource: KeycloakResource, permissionType: EPermissionType, body: Route.() -> Unit)

fun Route.requiresPermission(resource: KeycloakResource, scope: KeycloakScope, body: Route.() -> Unit)

fun Route.requiresRead(resource: KeycloakResource, body: Route.() -> Unit)

fun Route.requiresWrite(resource: KeycloakResource, body: Route.() -> Unit)

toKeycloakScope

fun EPermissionType.toKeycloakScope(): KeycloakScope