nimwire/auth

This page is generated from the module’s exported API and ## documentation comments.

HTTP authorization hooks with safe bearer-token defaults.

Types

McpAuthHeader

McpAuthHeader = object
  name*: string
  value*: string

View source

McpAuthorizationRequest

McpAuthorizationRequest = object
  methodName*: string
  path*: string
  resource*: string
  headers*: seq[McpAuthHeader]

View source

McpAuthClaims

McpAuthClaims = object
  subject*: string
  issuer*: string
  audience*: seq[string]
  scopes*: seq[string]
  expiresAt*: int64
  claims*: JsonNode

View source

McpBearerTokenVerifier

McpBearerTokenVerifier = proc (token, resource: string): McpAuthClaims {.closure.}

View source

McpAuthorizationMiddleware

McpAuthorizationMiddleware = proc (request: McpAuthorizationRequest): McpAuthorizationResult {.
    closure.}

View source

McpAuthorizationResult

McpAuthorizationResult = object
  allowed*: bool
  principal*: McpPrincipal
  status*: int
  message*: string
  scopes*: seq[string]

View source

McpProtectedResourceMetadata

McpProtectedResourceMetadata = object
  resource*: string
  authorizationServers*: seq[string]
  scopesSupported*: seq[string]

View source

McpAuthorizationConfig

McpAuthorizationConfig = object
  enabled*: bool
  resource*: string
  authorizationServers*: seq[string]
  scopesSupported*: seq[string]
  requiredScopes*: seq[string]
  resourceMetadataUrl*: string
  verifier*: McpBearerTokenVerifier
  middleware*: McpAuthorizationMiddleware

View source

McpClientIdMetadata

McpClientIdMetadata = object
  clientId*: string
  clientName*: string
  redirectUris*: seq[string]
  extraFields*: JsonNode

View source

Procedures

newMcpAuthClaims

proc newMcpAuthClaims(subject, issuer: string; audience, scopes: seq[string];
                      expiresAt: int64; claims: JsonNode = nil): McpAuthClaims {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpAuthClaims.

Arguments

Name	Type	Default
`subject`	`string`
`issuer`	`string`
`audience`	`seq[string]`
`scopes`	`seq[string]`
`expiresAt`	`int64`
`claims`	`JsonNode`	`nil`

View source

newMcpAuthorizationConfig

proc newMcpAuthorizationConfig(resource = "";
                               authorizationServers: seq[string] = @[];
                               scopesSupported: seq[string] = @[];
                               requiredScopes: seq[string] = @[];
                               resourceMetadataUrl = "";
                               verifier: McpBearerTokenVerifier = nil;
                               middleware: McpAuthorizationMiddleware = nil;
                               enabled = false): McpAuthorizationConfig {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpAuthorizationConfig.

Arguments

Name	Type	Default
`resource`	`inferred`	`""`
`authorizationServers`	`seq[string]`	`@[]`
`scopesSupported`	`seq[string]`	`@[]`
`requiredScopes`	`seq[string]`	`@[]`
`resourceMetadataUrl`	`inferred`	`""`
`verifier`	`McpBearerTokenVerifier`	`nil`
`middleware`	`McpAuthorizationMiddleware`	`nil`
`enabled`	`inferred`	`false`

View source

newMcpAuthorizationRequest

proc newMcpAuthorizationRequest(methodName, path, resource: string;
                                headers: seq[McpAuthHeader] = @[]): McpAuthorizationRequest {.
    raises: [], tags: [], forbids: [].}

Returns: McpAuthorizationRequest.

Arguments

Name	Type	Default
`methodName`	`string`
`path`	`string`
`resource`	`string`
`headers`	`seq[McpAuthHeader]`	`@[]`

View source

extractBearerToken

proc extractBearerToken(authorization: string): string {.raises: [], tags: [],
    forbids: [].}

Returns: string.

Arguments

Name	Type	Default
`authorization`	`string`

View source

authorize

proc authorize(config: McpAuthorizationConfig; request: McpAuthorizationRequest): McpAuthorizationResult {.
    raises: [Exception, Exception, McpError], tags: [RootEffect, TimeEffect],
    forbids: [].}

Returns: McpAuthorizationResult.

Arguments

Name	Type	Default
`config`	`McpAuthorizationConfig`
`request`	`McpAuthorizationRequest`

View source

protectedResourceMetadata

proc protectedResourceMetadata(config: McpAuthorizationConfig): McpProtectedResourceMetadata {.
    raises: [McpError], tags: [], forbids: [].}

Returns: McpProtectedResourceMetadata.

Arguments

Name	Type	Default
`config`	`McpAuthorizationConfig`

View source

toJson

proc toJson(metadata: McpProtectedResourceMetadata): JsonNode {.raises: [],
    tags: [], forbids: [].}

Returns: JsonNode.

Arguments

Name	Type	Default
`metadata`	`McpProtectedResourceMetadata`

View source

authorizationChallenge

proc authorizationChallenge(config: McpAuthorizationConfig; error = "";
                            scope = ""): string {.raises: [], tags: [],
    forbids: [].}

Returns: string.

Arguments

Name	Type	Default
`config`	`McpAuthorizationConfig`
`error`	`inferred`	`""`
`scope`	`inferred`	`""`

View source

parseClientIdMetadata

proc parseClientIdMetadata(node: JsonNode): McpClientIdMetadata {.
    raises: [McpError, KeyError], tags: [], forbids: [].}

Returns: McpClientIdMetadata.

Arguments

Name	Type	Default
`node`	`JsonNode`

View source

rejectTokenPassthrough

proc rejectTokenPassthrough(authorization: string) {.raises: [McpError],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
`authorization`	`string`

View source