2022-10-07 11:23:12 +02:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
2023-01-08 23:35:11 +01:00
< link rel = "prev" href = "../radiusclient/" >
2022-10-07 11:23:12 +02:00
< link rel = "icon" href = "../assets/images/favicon.png" >
2023-02-17 08:24:03 +01:00
< meta name = "generator" content = "mkdocs-1.4.2, mkdocs-material-9.0.12" >
2022-10-07 11:23:12 +02:00
< title > Token Storage - kanidm python library< / title >
2023-02-17 08:24:03 +01:00
< link rel = "stylesheet" href = "../assets/stylesheets/main.0d440cfe.min.css" >
2022-10-07 11:23:12 +02:00
2022-12-04 23:16:42 +01:00
< link rel = "stylesheet" href = "../assets/stylesheets/palette.2505c338.min.css" >
2022-10-07 11:23:12 +02:00
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< link rel = "stylesheet" href = "../assets/_mkdocstrings.css" >
< script > _ _md _scope = new URL ( ".." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
< / head >
2023-01-08 23:35:11 +01:00
< body dir = "ltr" data-md-color-scheme = "default" data-md-color-primary = "" data-md-color-accent = "" >
2022-10-07 11:23:12 +02:00
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#kanidm.tokens" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = ".." title = "kanidm python library" class = "md-header__button md-logo" aria-label = "kanidm python library" data-md-component = "logo" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
kanidm python library
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
Token Storage
< / span >
< / div >
< / div >
< / div >
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z" / > < / svg >
< / button >
< / nav >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
2023-01-16 05:32:08 +01:00
< ol class = "md-search-result__list" role = "presentation" > < / ol >
2022-10-07 11:23:12 +02:00
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-header__source" >
< a href = "https://github.com/kanidm/kanidm" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2022-12-04 23:16:42 +01:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
2022-10-07 11:23:12 +02:00
< / div >
< div class = "md-source__repository" >
kanidm/kanidm
< / div >
< / a >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = ".." title = "kanidm python library" class = "md-nav__button md-logo" aria-label = "kanidm python library" data-md-component = "logo" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg >
< / a >
kanidm python library
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/kanidm/kanidm" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2022-12-04 23:16:42 +01:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
2022-10-07 11:23:12 +02:00
< / div >
< div class = "md-source__repository" >
kanidm/kanidm
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = ".." class = "md-nav__link" >
Home
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../kanidmclient/" class = "md-nav__link" >
Client
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../kanidmclientconfig/" class = "md-nav__link" >
Client Configuration
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../radiusclient/" class = "md-nav__link" >
RADIUS Client
< / a >
< / li >
< li class = "md-nav__item md-nav__item--active" >
2023-02-17 08:24:03 +01:00
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
2022-10-07 11:23:12 +02:00
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
Token Storage
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "./" class = "md-nav__link md-nav__link--active" >
Token Storage
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens" class = "md-nav__link" >
kanidm.tokens
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWS" class = "md-nav__link" >
JWS
< / a >
< nav class = "md-nav" aria-label = "JWS" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWS.__init__" class = "md-nav__link" >
__init__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWS.parse" class = "md-nav__link" >
parse()
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSHeader" class = "md-nav__link" >
JWSHeader
< / a >
< nav class = "md-nav" aria-label = "JWSHeader" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSHeader.Config" class = "md-nav__link" >
Config
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSHeader.JWSHeaderJWK" class = "md-nav__link" >
JWSHeaderJWK
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSPayload" class = "md-nav__link" >
JWSPayload
< / a >
< nav class = "md-nav" aria-label = "JWSPayload" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSPayload.expiry_datetime" class = "md-nav__link" >
2023-01-24 00:58:53 +01:00
expiry_datetime
2022-10-07 11:23:12 +02:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore" class = "md-nav__link" >
TokenStore
< / a >
< nav class = "md-nav" aria-label = "TokenStore" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.__delitem__" class = "md-nav__link" >
__delitem__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.__getitem__" class = "md-nav__link" >
__getitem__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.__iter__" class = "md-nav__link" >
__iter__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.__setitem__" class = "md-nav__link" >
__setitem__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.load" class = "md-nav__link" >
load()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.save" class = "md-nav__link" >
save()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.token_info" class = "md-nav__link" >
token_info()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.validate_tokens" class = "md-nav__link" >
validate_tokens()
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "sidebar" data-md-type = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens" class = "md-nav__link" >
kanidm.tokens
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWS" class = "md-nav__link" >
JWS
< / a >
< nav class = "md-nav" aria-label = "JWS" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWS.__init__" class = "md-nav__link" >
__init__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWS.parse" class = "md-nav__link" >
parse()
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSHeader" class = "md-nav__link" >
JWSHeader
< / a >
< nav class = "md-nav" aria-label = "JWSHeader" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSHeader.Config" class = "md-nav__link" >
Config
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSHeader.JWSHeaderJWK" class = "md-nav__link" >
JWSHeaderJWK
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSPayload" class = "md-nav__link" >
JWSPayload
< / a >
< nav class = "md-nav" aria-label = "JWSPayload" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.JWSPayload.expiry_datetime" class = "md-nav__link" >
2023-01-24 00:58:53 +01:00
expiry_datetime
2022-10-07 11:23:12 +02:00
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore" class = "md-nav__link" >
TokenStore
< / a >
< nav class = "md-nav" aria-label = "TokenStore" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.__delitem__" class = "md-nav__link" >
__delitem__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.__getitem__" class = "md-nav__link" >
__getitem__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.__iter__" class = "md-nav__link" >
__iter__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.__setitem__" class = "md-nav__link" >
__setitem__()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.load" class = "md-nav__link" >
load()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.save" class = "md-nav__link" >
save()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.token_info" class = "md-nav__link" >
token_info()
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#kanidm.tokens.TokenStore.validate_tokens" class = "md-nav__link" >
validate_tokens()
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
2023-01-08 23:35:11 +01:00
2022-10-07 11:23:12 +02:00
< h1 > Token Storage< / h1 >
< div class = "doc doc-object doc-module" >
< a id = "kanidm.tokens" > < / a >
< div class = "doc doc-contents first" >
< p > User Auth Token related widgets< / p >
< div class = "doc doc-children" >
< div class = "doc doc-object doc-class" >
< h2 id = "kanidm.tokens.JWS" class = "doc doc-heading" >
< code > JWS< / code >
< / h2 >
< div class = "doc doc-contents " >
< p > JWS parser< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 71< / span >
< span class = "normal" > 72< / span >
< span class = "normal" > 73< / span >
< span class = "normal" > 74< / span >
< span class = "normal" > 75< / span >
< span class = "normal" > 76< / span >
< span class = "normal" > 77< / span >
< span class = "normal" > 78< / span >
< span class = "normal" > 79< / span >
< span class = "normal" > 80< / span >
< span class = "normal" > 81< / span >
< span class = "normal" > 82< / span >
< span class = "normal" > 83< / span >
< span class = "normal" > 84< / span >
< span class = "normal" > 85< / span >
< span class = "normal" > 86< / span >
< span class = "normal" > 87< / span >
< span class = "normal" > 88< / span >
< span class = "normal" > 89< / span >
< span class = "normal" > 90< / span >
< span class = "normal" > 91< / span >
< span class = "normal" > 92< / span >
< span class = "normal" > 93< / span >
< span class = "normal" > 94< / span >
< span class = "normal" > 95< / span >
< span class = "normal" > 96< / span >
< span class = "normal" > 97< / span >
< span class = "normal" > 98< / span >
< span class = "normal" > 99< / span >
< span class = "normal" > 100< / span >
< span class = "normal" > 101< / span >
< span class = "normal" > 102< / span >
< span class = "normal" > 103< / span >
< span class = "normal" > 104< / span >
< span class = "normal" > 105< / span >
< span class = "normal" > 106< / span >
< span class = "normal" > 107< / span >
< span class = "normal" > 108< / span >
< span class = "normal" > 109< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > class< / span > < span class = "nc" > JWS< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " JWS parser" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > def< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > raw< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " raw is the raw string version of the JWS" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > parse< / span > < span class = "p" > (< / span > < span class = "n" > raw< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > header< / span > < span class = "o" > =< / span > < span class = "n" > data< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > payload< / span > < span class = "o" > =< / span > < span class = "n" > data< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > signature< / span > < span class = "o" > =< / span > < span class = "n" > data< / span > < span class = "p" > [< / span > < span class = "mi" > 2< / span > < span class = "p" > ]< / span >
< span class = "nd" > @classmethod< / span >
< span class = "k" > def< / span > < span class = "nf" > parse< / span > < span class = "p" > (< / span > < span class = "bp" > cls< / span > < span class = "p" > ,< / span > < span class = "n" > raw< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > Tuple< / span > < span class = "p" > [< / span > < span class = "n" > JWSHeader< / span > < span class = "p" > ,< / span > < span class = "n" > JWSPayload< / span > < span class = "p" > ,< / span > < span class = "nb" > bytes< / span > < span class = "p" > ]:< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " parse a raw JWS" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > if< / span > < span class = "s2" > " ." < / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > raw< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > ValueError< / span > < span class = "p" > (< / span > < span class = "s2" > " Invalid number of segments, there' s no . in the raw JWS" < / span > < span class = "p" > )< / span >
< span class = "n" > split_raw< / span > < span class = "o" > =< / span > < span class = "n" > raw< / span > < span class = "o" > .< / span > < span class = "n" > split< / span > < span class = "p" > (< / span > < span class = "s2" > " ." < / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > split_raw< / span > < span class = "p" > )< / span > < span class = "o" > !=< / span > < span class = "mi" > 3< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > ValueError< / span > < span class = "p" > (< / span > < span class = "s2" > " Invalid number of segments" < / span > < span class = "p" > )< / span >
< span class = "n" > raw_header< / span > < span class = "o" > =< / span > < span class = "n" > split_raw< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " Parsing header: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > raw_header< / span > < span class = "p" > )< / span >
< span class = "n" > padded_header< / span > < span class = "o" > =< / span > < span class = "n" > raw_header< / span > < span class = "o" > +< / span > < span class = "s2" > " =" < / span > < span class = "o" > *< / span > < span class = "nb" > divmod< / span > < span class = "p" > (< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > raw_header< / span > < span class = "p" > ),< / span > < span class = "mi" > 4< / span > < span class = "p" > )[< / span > < span class = "mi" > 0< / span > < span class = "p" > ]< / span >
< span class = "n" > decoded_header< / span > < span class = "o" > =< / span > < span class = "n" > base64< / span > < span class = "o" > .< / span > < span class = "n" > urlsafe_b64decode< / span > < span class = "p" > (< / span > < span class = "n" > padded_header< / span > < span class = "p" > )< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " decoded_header=< / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > decoded_header< / span > < span class = "p" > )< / span >
< span class = "n" > header< / span > < span class = "o" > =< / span > < span class = "n" > JWSHeader< / span > < span class = "o" > .< / span > < span class = "n" > parse_obj< / span > < span class = "p" > (< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > decoded_header< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > )))< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " header: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > header< / span > < span class = "p" > )< / span >
< span class = "n" > raw_payload< / span > < span class = "o" > =< / span > < span class = "n" > split_raw< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " Parsing payload: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > raw_payload< / span > < span class = "p" > )< / span >
< span class = "n" > padded_payload< / span > < span class = "o" > =< / span > < span class = "n" > raw_payload< / span > < span class = "o" > +< / span > < span class = "s2" > " =" < / span > < span class = "o" > *< / span > < span class = "nb" > divmod< / span > < span class = "p" > (< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > raw_payload< / span > < span class = "p" > ),< / span > < span class = "mi" > 4< / span > < span class = "p" > )[< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span >
< span class = "n" > payload< / span > < span class = "o" > =< / span > < span class = "n" > JWSPayload< / span > < span class = "o" > .< / span > < span class = "n" > parse_raw< / span > < span class = "p" > (< / span > < span class = "n" > base64< / span > < span class = "o" > .< / span > < span class = "n" > urlsafe_b64decode< / span > < span class = "p" > (< / span > < span class = "n" > padded_payload< / span > < span class = "p" > ))< / span >
< span class = "n" > raw_signature< / span > < span class = "o" > =< / span > < span class = "n" > split_raw< / span > < span class = "p" > [< / span > < span class = "mi" > 2< / span > < span class = "p" > ]< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " Parsing signature: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > raw_signature< / span > < span class = "p" > )< / span >
< span class = "n" > padded_signature< / span > < span class = "o" > =< / span > < span class = "n" > raw_signature< / span > < span class = "o" > +< / span > < span class = "s2" > " =" < / span > < span class = "o" > *< / span > < span class = "nb" > divmod< / span > < span class = "p" > (< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > raw_signature< / span > < span class = "p" > ),< / span > < span class = "mi" > 4< / span > < span class = "p" > )[< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span >
< span class = "n" > signature< / span > < span class = "o" > =< / span > < span class = "n" > base64< / span > < span class = "o" > .< / span > < span class = "n" > urlsafe_b64decode< / span > < span class = "p" > (< / span > < span class = "n" > padded_signature< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > header< / span > < span class = "p" > ,< / span > < span class = "n" > payload< / span > < span class = "p" > ,< / span > < span class = "n" > signature< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< div class = "doc doc-children" >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.JWS.__init__" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "n" > raw< / span > < span class = "p" > )< / span > < / code >
< / h3 >
< div class = "doc doc-contents " >
< p > raw is the raw string version of the JWS< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 74< / span >
< span class = "normal" > 75< / span >
< span class = "normal" > 76< / span >
< span class = "normal" > 77< / span >
< span class = "normal" > 78< / span >
< span class = "normal" > 79< / span >
< span class = "normal" > 80< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > def< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > raw< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " raw is the raw string version of the JWS" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > parse< / span > < span class = "p" > (< / span > < span class = "n" > raw< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > header< / span > < span class = "o" > =< / span > < span class = "n" > data< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > payload< / span > < span class = "o" > =< / span > < span class = "n" > data< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > signature< / span > < span class = "o" > =< / span > < span class = "n" > data< / span > < span class = "p" > [< / span > < span class = "mi" > 2< / span > < span class = "p" > ]< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.JWS.parse" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "n" > parse< / span > < span class = "p" > (< / span > < span class = "n" > raw< / span > < span class = "p" > )< / span > < / code >
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-classmethod" > < code > classmethod< / code > < / small >
< / span >
< / h3 >
< div class = "doc doc-contents " >
< p > parse a raw JWS< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 82< / span >
< span class = "normal" > 83< / span >
< span class = "normal" > 84< / span >
< span class = "normal" > 85< / span >
< span class = "normal" > 86< / span >
< span class = "normal" > 87< / span >
< span class = "normal" > 88< / span >
< span class = "normal" > 89< / span >
< span class = "normal" > 90< / span >
< span class = "normal" > 91< / span >
< span class = "normal" > 92< / span >
< span class = "normal" > 93< / span >
< span class = "normal" > 94< / span >
< span class = "normal" > 95< / span >
< span class = "normal" > 96< / span >
< span class = "normal" > 97< / span >
< span class = "normal" > 98< / span >
< span class = "normal" > 99< / span >
< span class = "normal" > 100< / span >
< span class = "normal" > 101< / span >
< span class = "normal" > 102< / span >
< span class = "normal" > 103< / span >
< span class = "normal" > 104< / span >
< span class = "normal" > 105< / span >
< span class = "normal" > 106< / span >
< span class = "normal" > 107< / span >
< span class = "normal" > 108< / span >
< span class = "normal" > 109< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "nd" > @classmethod< / span >
< span class = "k" > def< / span > < span class = "nf" > parse< / span > < span class = "p" > (< / span > < span class = "bp" > cls< / span > < span class = "p" > ,< / span > < span class = "n" > raw< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > Tuple< / span > < span class = "p" > [< / span > < span class = "n" > JWSHeader< / span > < span class = "p" > ,< / span > < span class = "n" > JWSPayload< / span > < span class = "p" > ,< / span > < span class = "nb" > bytes< / span > < span class = "p" > ]:< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " parse a raw JWS" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > if< / span > < span class = "s2" > " ." < / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > raw< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > ValueError< / span > < span class = "p" > (< / span > < span class = "s2" > " Invalid number of segments, there' s no . in the raw JWS" < / span > < span class = "p" > )< / span >
< span class = "n" > split_raw< / span > < span class = "o" > =< / span > < span class = "n" > raw< / span > < span class = "o" > .< / span > < span class = "n" > split< / span > < span class = "p" > (< / span > < span class = "s2" > " ." < / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > split_raw< / span > < span class = "p" > )< / span > < span class = "o" > !=< / span > < span class = "mi" > 3< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > ValueError< / span > < span class = "p" > (< / span > < span class = "s2" > " Invalid number of segments" < / span > < span class = "p" > )< / span >
< span class = "n" > raw_header< / span > < span class = "o" > =< / span > < span class = "n" > split_raw< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " Parsing header: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > raw_header< / span > < span class = "p" > )< / span >
< span class = "n" > padded_header< / span > < span class = "o" > =< / span > < span class = "n" > raw_header< / span > < span class = "o" > +< / span > < span class = "s2" > " =" < / span > < span class = "o" > *< / span > < span class = "nb" > divmod< / span > < span class = "p" > (< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > raw_header< / span > < span class = "p" > ),< / span > < span class = "mi" > 4< / span > < span class = "p" > )[< / span > < span class = "mi" > 0< / span > < span class = "p" > ]< / span >
< span class = "n" > decoded_header< / span > < span class = "o" > =< / span > < span class = "n" > base64< / span > < span class = "o" > .< / span > < span class = "n" > urlsafe_b64decode< / span > < span class = "p" > (< / span > < span class = "n" > padded_header< / span > < span class = "p" > )< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " decoded_header=< / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > decoded_header< / span > < span class = "p" > )< / span >
< span class = "n" > header< / span > < span class = "o" > =< / span > < span class = "n" > JWSHeader< / span > < span class = "o" > .< / span > < span class = "n" > parse_obj< / span > < span class = "p" > (< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > decoded_header< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > )))< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " header: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > header< / span > < span class = "p" > )< / span >
< span class = "n" > raw_payload< / span > < span class = "o" > =< / span > < span class = "n" > split_raw< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " Parsing payload: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > raw_payload< / span > < span class = "p" > )< / span >
< span class = "n" > padded_payload< / span > < span class = "o" > =< / span > < span class = "n" > raw_payload< / span > < span class = "o" > +< / span > < span class = "s2" > " =" < / span > < span class = "o" > *< / span > < span class = "nb" > divmod< / span > < span class = "p" > (< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > raw_payload< / span > < span class = "p" > ),< / span > < span class = "mi" > 4< / span > < span class = "p" > )[< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span >
< span class = "n" > payload< / span > < span class = "o" > =< / span > < span class = "n" > JWSPayload< / span > < span class = "o" > .< / span > < span class = "n" > parse_raw< / span > < span class = "p" > (< / span > < span class = "n" > base64< / span > < span class = "o" > .< / span > < span class = "n" > urlsafe_b64decode< / span > < span class = "p" > (< / span > < span class = "n" > padded_payload< / span > < span class = "p" > ))< / span >
< span class = "n" > raw_signature< / span > < span class = "o" > =< / span > < span class = "n" > split_raw< / span > < span class = "p" > [< / span > < span class = "mi" > 2< / span > < span class = "p" > ]< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " Parsing signature: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > raw_signature< / span > < span class = "p" > )< / span >
< span class = "n" > padded_signature< / span > < span class = "o" > =< / span > < span class = "n" > raw_signature< / span > < span class = "o" > +< / span > < span class = "s2" > " =" < / span > < span class = "o" > *< / span > < span class = "nb" > divmod< / span > < span class = "p" > (< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > raw_signature< / span > < span class = "p" > ),< / span > < span class = "mi" > 4< / span > < span class = "p" > )[< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span >
< span class = "n" > signature< / span > < span class = "o" > =< / span > < span class = "n" > base64< / span > < span class = "o" > .< / span > < span class = "n" > urlsafe_b64decode< / span > < span class = "p" > (< / span > < span class = "n" > padded_signature< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > header< / span > < span class = "p" > ,< / span > < span class = "n" > payload< / span > < span class = "p" > ,< / span > < span class = "n" > signature< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "doc doc-object doc-class" >
< h2 id = "kanidm.tokens.JWSHeader" class = "doc doc-heading" >
< code > JWSHeader< / code >
< / h2 >
< div class = "doc doc-contents " >
< p class = "doc doc-class-bases" >
Bases: < code > < span title = "pydantic.BaseModel" > BaseModel< / span > < / code > < / p >
< p > JWS Header Parser< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 18< / span >
< span class = "normal" > 19< / span >
< span class = "normal" > 20< / span >
< span class = "normal" > 21< / span >
< span class = "normal" > 22< / span >
< span class = "normal" > 23< / span >
< span class = "normal" > 24< / span >
< span class = "normal" > 25< / span >
< span class = "normal" > 26< / span >
< span class = "normal" > 27< / span >
< span class = "normal" > 28< / span >
< span class = "normal" > 29< / span >
< span class = "normal" > 30< / span >
< span class = "normal" > 31< / span >
< span class = "normal" > 32< / span >
< span class = "normal" > 33< / span >
< span class = "normal" > 34< / span >
< span class = "normal" > 35< / span >
< span class = "normal" > 36< / span >
< span class = "normal" > 37< / span >
< span class = "normal" > 38< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > class< / span > < span class = "nc" > JWSHeader< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " JWS Header Parser" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > class< / span > < span class = "nc" > JWSHeaderJWK< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " JWS Header Sub-bit" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > kty< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > crv< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > x< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > y< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > alg< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > use< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > alg< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > typ< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > jwk< / span > < span class = "p" > :< / span > < span class = "n" > JWSHeaderJWK< / span >
< span class = "k" > class< / span > < span class = "nc" > Config< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " Configure the pydantic class" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > arbitrary_types_allowed< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< div class = "doc doc-children" >
< div class = "doc doc-object doc-class" >
< h3 id = "kanidm.tokens.JWSHeader.Config" class = "doc doc-heading" >
< code > Config< / code >
< / h3 >
< div class = "doc doc-contents " >
< p > Configure the pydantic class< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 35< / span >
< span class = "normal" > 36< / span >
< span class = "normal" > 37< / span >
< span class = "normal" > 38< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > class< / span > < span class = "nc" > Config< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " Configure the pydantic class" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > arbitrary_types_allowed< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< div class = "doc doc-children" >
< / div >
< / div >
< / div >
< div class = "doc doc-object doc-class" >
< h3 id = "kanidm.tokens.JWSHeader.JWSHeaderJWK" class = "doc doc-heading" >
< code > JWSHeaderJWK< / code >
< / h3 >
< div class = "doc doc-contents " >
< p class = "doc doc-class-bases" >
Bases: < code > < span title = "pydantic.BaseModel" > BaseModel< / span > < / code > < / p >
< p > JWS Header Sub-bit< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 21< / span >
< span class = "normal" > 22< / span >
< span class = "normal" > 23< / span >
< span class = "normal" > 24< / span >
< span class = "normal" > 25< / span >
< span class = "normal" > 26< / span >
< span class = "normal" > 27< / span >
< span class = "normal" > 28< / span >
< span class = "normal" > 29< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > class< / span > < span class = "nc" > JWSHeaderJWK< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " JWS Header Sub-bit" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > kty< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > crv< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > x< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > y< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > alg< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > use< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< div class = "doc doc-children" >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "doc doc-object doc-class" >
< h2 id = "kanidm.tokens.JWSPayload" class = "doc doc-heading" >
< code > JWSPayload< / code >
< / h2 >
< div class = "doc doc-contents " >
< p class = "doc doc-class-bases" >
Bases: < code > < span title = "pydantic.BaseModel" > BaseModel< / span > < / code > < / p >
< p > JWS Payload parser< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 41< / span >
< span class = "normal" > 42< / span >
< span class = "normal" > 43< / span >
< span class = "normal" > 44< / span >
< span class = "normal" > 45< / span >
< span class = "normal" > 46< / span >
< span class = "normal" > 47< / span >
< span class = "normal" > 48< / span >
< span class = "normal" > 49< / span >
< span class = "normal" > 50< / span >
< span class = "normal" > 51< / span >
< span class = "normal" > 52< / span >
< span class = "normal" > 53< / span >
< span class = "normal" > 54< / span >
< span class = "normal" > 55< / span >
< span class = "normal" > 56< / span >
< span class = "normal" > 57< / span >
< span class = "normal" > 58< / span >
< span class = "normal" > 59< / span >
< span class = "normal" > 60< / span >
< span class = "normal" > 61< / span >
< span class = "normal" > 62< / span >
< span class = "normal" > 63< / span >
< span class = "normal" > 64< / span >
< span class = "normal" > 65< / span >
< span class = "normal" > 66< / span >
< span class = "normal" > 67< / span >
< span class = "normal" > 68< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > class< / span > < span class = "nc" > JWSPayload< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " JWS Payload parser" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > session_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > auth_type< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "c1" > # TODO: work out the format of the expiry< / span >
< span class = "c1" > # example expiry: 2022,265,28366,802525000< / span >
< span class = "n" > expiry< / span > < span class = "p" > :< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "nb" > int< / span > < span class = "p" > ]< / span > < span class = "c1" > # [year, day of year, something?]< / span >
< span class = "n" > uuid< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > name< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > displayname< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > spn< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > mail_primary< / span > < span class = "p" > :< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span >
< span class = "n" > lim_uidx< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
< span class = "n" > lim_rmax< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span >
< span class = "n" > lim_pmax< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span >
< span class = "n" > lim_fmax< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span >
< span class = "nd" > @property< / span >
< span class = "k" > def< / span > < span class = "nf" > expiry_datetime< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > datetime< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " parse the expiry and return a datetime object" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > year< / span > < span class = "p" > ,< / span > < span class = "n" > day< / span > < span class = "p" > ,< / span > < span class = "n" > seconds< / span > < span class = "p" > ,< / span > < span class = "n" > _< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > expiry< / span >
< span class = "n" > retval< / span > < span class = "o" > =< / span > < span class = "n" > datetime< / span > < span class = "p" > (< / span >
< span class = "n" > year< / span > < span class = "o" > =< / span > < span class = "n" > year< / span > < span class = "p" > ,< / span > < span class = "n" > month< / span > < span class = "o" > =< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "n" > day< / span > < span class = "o" > =< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "n" > second< / span > < span class = "o" > =< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "n" > hour< / span > < span class = "o" > =< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "n" > tzinfo< / span > < span class = "o" > =< / span > < span class = "n" > timezone< / span > < span class = "o" > .< / span > < span class = "n" > utc< / span >
< span class = "p" > )< / span >
< span class = "c1" > # day - 1 because we' re already starting at day 1< / span >
< span class = "n" > retval< / span > < span class = "o" > +=< / span > < span class = "n" > timedelta< / span > < span class = "p" > (< / span > < span class = "n" > days< / span > < span class = "o" > =< / span > < span class = "n" > day< / span > < span class = "o" > -< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "n" > seconds< / span > < span class = "o" > =< / span > < span class = "n" > seconds< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > retval< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< div class = "doc doc-children" >
2023-01-24 00:58:53 +01:00
< div class = "doc doc-object doc-attribute" >
2022-10-07 11:23:12 +02:00
< h3 id = "kanidm.tokens.JWSPayload.expiry_datetime" class = "doc doc-heading" >
2023-01-24 00:58:53 +01:00
< code class = "highlight language-python" > < span class = "n" > expiry_datetime< / span > < span class = "p" > :< / span > < span class = "n" > datetime< / span > < / code >
2022-10-07 11:23:12 +02:00
< span class = "doc doc-labels" >
< small class = "doc doc-label doc-label-property" > < code > property< / code > < / small >
< / span >
< / h3 >
< div class = "doc doc-contents " >
< p > parse the expiry and return a datetime object< / p >
< / div >
< / div >
2023-01-24 00:58:53 +01:00
2022-10-07 11:23:12 +02:00
< / div >
< / div >
< / div >
< div class = "doc doc-object doc-class" >
< h2 id = "kanidm.tokens.TokenStore" class = "doc doc-heading" >
< code > TokenStore< / code >
< / h2 >
< div class = "doc doc-contents " >
< p class = "doc doc-class-bases" >
Bases: < code > < span title = "pydantic.BaseModel" > BaseModel< / span > < / code > < / p >
< p > Represents the user auth tokens, can load them from the user store< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 112< / span >
< span class = "normal" > 113< / span >
< span class = "normal" > 114< / span >
< span class = "normal" > 115< / span >
< span class = "normal" > 116< / span >
< span class = "normal" > 117< / span >
< span class = "normal" > 118< / span >
< span class = "normal" > 119< / span >
< span class = "normal" > 120< / span >
< span class = "normal" > 121< / span >
< span class = "normal" > 122< / span >
< span class = "normal" > 123< / span >
< span class = "normal" > 124< / span >
< span class = "normal" > 125< / span >
< span class = "normal" > 126< / span >
< span class = "normal" > 127< / span >
< span class = "normal" > 128< / span >
< span class = "normal" > 129< / span >
< span class = "normal" > 130< / span >
< span class = "normal" > 131< / span >
< span class = "normal" > 132< / span >
< span class = "normal" > 133< / span >
< span class = "normal" > 134< / span >
< span class = "normal" > 135< / span >
< span class = "normal" > 136< / span >
< span class = "normal" > 137< / span >
< span class = "normal" > 138< / span >
< span class = "normal" > 139< / span >
< span class = "normal" > 140< / span >
< span class = "normal" > 141< / span >
< span class = "normal" > 142< / span >
< span class = "normal" > 143< / span >
< span class = "normal" > 144< / span >
< span class = "normal" > 145< / span >
< span class = "normal" > 146< / span >
< span class = "normal" > 147< / span >
< span class = "normal" > 148< / span >
< span class = "normal" > 149< / span >
< span class = "normal" > 150< / span >
< span class = "normal" > 151< / span >
< span class = "normal" > 152< / span >
< span class = "normal" > 153< / span >
< span class = "normal" > 154< / span >
< span class = "normal" > 155< / span >
< span class = "normal" > 156< / span >
< span class = "normal" > 157< / span >
< span class = "normal" > 158< / span >
< span class = "normal" > 159< / span >
< span class = "normal" > 160< / span >
< span class = "normal" > 161< / span >
< span class = "normal" > 162< / span >
< span class = "normal" > 163< / span >
< span class = "normal" > 164< / span >
< span class = "normal" > 165< / span >
< span class = "normal" > 166< / span >
< span class = "normal" > 167< / span >
< span class = "normal" > 168< / span >
< span class = "normal" > 169< / span >
< span class = "normal" > 170< / span >
< span class = "normal" > 171< / span >
< span class = "normal" > 172< / span >
< span class = "normal" > 173< / span >
< span class = "normal" > 174< / span >
< span class = "normal" > 175< / span >
< span class = "normal" > 176< / span >
< span class = "normal" > 177< / span >
< span class = "normal" > 178< / span >
< span class = "normal" > 179< / span >
< span class = "normal" > 180< / span >
< span class = "normal" > 181< / span >
< span class = "normal" > 182< / span >
< span class = "normal" > 183< / span >
< span class = "normal" > 184< / span >
< span class = "normal" > 185< / span >
< span class = "normal" > 186< / span >
< span class = "normal" > 187< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > class< / span > < span class = "nc" > TokenStore< / span > < span class = "p" > (< / span > < span class = "n" > BaseModel< / span > < span class = "p" > ):< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " Represents the user auth tokens, can load them from the user store" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > __root__< / span > < span class = "p" > :< / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > {}< / span >
< span class = "c1" > # TODO: one day work out how to type the __iter__ on TokenStore properly. It' s some kind of iter() that makes mypy unhappy.< / span >
< span class = "k" > def< / span > < span class = "fm" > __iter__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > Any< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " overloading the default function" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > for< / span > < span class = "n" > key< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "o" > .< / span > < span class = "n" > keys< / span > < span class = "p" > ():< / span >
< span class = "k" > yield< / span > < span class = "n" > key< / span >
< span class = "k" > def< / span > < span class = "fm" > __getitem__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > item< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > str< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " overloading the default function" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > [< / span > < span class = "n" > item< / span > < span class = "p" > ]< / span >
< span class = "k" > def< / span > < span class = "fm" > __delitem__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > item< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " overloading the default function" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > del< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > [< / span > < span class = "n" > item< / span > < span class = "p" > ]< / span >
< span class = "k" > def< / span > < span class = "fm" > __setitem__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > key< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " overloading the default function" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > [< / span > < span class = "n" > key< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > value< / span >
< span class = "k" > def< / span > < span class = "nf" > save< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > filepath< / span > < span class = "p" > :< / span > < span class = "n" > Path< / span > < span class = "o" > =< / span > < span class = "n" > TOKEN_PATH< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " saves the cached tokens to disk" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > dumps< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > ,< / span > < span class = "n" > indent< / span > < span class = "o" > =< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span >
< span class = "k" > with< / span > < span class = "n" > filepath< / span > < span class = "o" > .< / span > < span class = "n" > expanduser< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > resolve< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > open< / span > < span class = "p" > (< / span >
< span class = "n" > mode< / span > < span class = "o" > =< / span > < span class = "s2" > " w" < / span > < span class = "p" > ,< / span > < span class = "n" > encoding< / span > < span class = "o" > =< / span > < span class = "s2" > " utf-8" < / span >
< span class = "p" > )< / span > < span class = "k" > as< / span > < span class = "n" > file_handle< / span > < span class = "p" > :< / span >
< span class = "n" > file_handle< / span > < span class = "o" > .< / span > < span class = "n" > write< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > load< / span > < span class = "p" > (< / span >
< span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > overwrite< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > ,< / span > < span class = "n" > filepath< / span > < span class = "p" > :< / span > < span class = "n" > Path< / span > < span class = "o" > =< / span > < span class = "n" > TOKEN_PATH< / span >
< span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > str< / span > < span class = "p" > ]:< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " Loads the tokens from from the store and caches them in memory - by default< / span >
2022-10-07 11:23:12 +02:00
< span class = "sd" > from the local user' s store path, but you can point it at any file path.< / span >
< span class = "sd" > Will return the current cached store.< / span >
< span class = "sd" > If overwrite=False, then it will add them to the existing in-memory store" " " < / span >
< span class = "n" > token_path< / span > < span class = "o" > =< / span > < span class = "n" > filepath< / span > < span class = "o" > .< / span > < span class = "n" > expanduser< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > resolve< / span > < span class = "p" > ()< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > token_path< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > ():< / span >
< span class = "n" > tokens< / span > < span class = "p" > :< / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > {}< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "k" > with< / span > < span class = "n" > token_path< / span > < span class = "o" > .< / span > < span class = "n" > open< / span > < span class = "p" > (< / span > < span class = "n" > encoding< / span > < span class = "o" > =< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > )< / span > < span class = "k" > as< / span > < span class = "n" > file_handle< / span > < span class = "p" > :< / span >
< span class = "n" > tokens< / span > < span class = "o" > =< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > load< / span > < span class = "p" > (< / span > < span class = "n" > file_handle< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > overwrite< / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "o" > =< / span > < span class = "n" > tokens< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "k" > for< / span > < span class = "n" > user< / span > < span class = "ow" > in< / span > < span class = "n" > tokens< / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > [< / span > < span class = "n" > user< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > tokens< / span > < span class = "p" > [< / span > < span class = "n" > user< / span > < span class = "p" > ]< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > validate_tokens< / span > < span class = "p" > ()< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > dumps< / span > < span class = "p" > (< / span > < span class = "n" > tokens< / span > < span class = "p" > ,< / span > < span class = "n" > indent< / span > < span class = "o" > =< / span > < span class = "mi" > 4< / span > < span class = "p" > ))< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span >
< span class = "k" > def< / span > < span class = "nf" > validate_tokens< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " validates the JWS tokens for format, not their signature - PRs welcome" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > for< / span > < span class = "n" > username< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > :< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " Parsing < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > username< / span > < span class = "p" > )< / span >
< span class = "c1" > # TODO: Work out how to get the validation working. We probably shouldn' t be worried about this since we' re using it for auth...< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span >
< span class = "n" > JsonWebSignature< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > deserialize_compact< / span > < span class = "p" > (< / span > < span class = "n" > s< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "p" > [< / span > < span class = "n" > username< / span > < span class = "p" > ],< / span > < span class = "n" > key< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > token_info< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > username< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > JWSPayload< / span > < span class = "p" > ]:< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " grabs a token and returns a complex object object" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > if< / span > < span class = "n" > username< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "p" > :< / span >
< span class = "k" > return< / span > < span class = "kc" > None< / span >
< span class = "n" > parsed_object< / span > < span class = "o" > =< / span > < span class = "n" > JsonWebSignature< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > deserialize_compact< / span > < span class = "p" > (< / span >
< span class = "n" > s< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "p" > [< / span > < span class = "n" > username< / span > < span class = "p" > ],< / span > < span class = "n" > key< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span >
< span class = "p" > )< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "n" > parsed_object< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > JWSPayload< / span > < span class = "o" > .< / span > < span class = "n" > parse_raw< / span > < span class = "p" > (< / span > < span class = "n" > parsed_object< / span > < span class = "o" > .< / span > < span class = "n" > payload< / span > < span class = "p" > )< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< div class = "doc doc-children" >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.TokenStore.__delitem__" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "fm" > __delitem__< / span > < span class = "p" > (< / span > < span class = "n" > item< / span > < span class = "p" > )< / span > < / code >
< / h3 >
< div class = "doc doc-contents " >
< p > overloading the default function< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 127< / span >
< span class = "normal" > 128< / span >
< span class = "normal" > 129< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > def< / span > < span class = "fm" > __delitem__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > item< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " overloading the default function" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > del< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > [< / span > < span class = "n" > item< / span > < span class = "p" > ]< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.TokenStore.__getitem__" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "fm" > __getitem__< / span > < span class = "p" > (< / span > < span class = "n" > item< / span > < span class = "p" > )< / span > < / code >
< / h3 >
< div class = "doc doc-contents " >
< p > overloading the default function< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 123< / span >
< span class = "normal" > 124< / span >
< span class = "normal" > 125< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > def< / span > < span class = "fm" > __getitem__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > item< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > str< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " overloading the default function" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > [< / span > < span class = "n" > item< / span > < span class = "p" > ]< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.TokenStore.__iter__" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "fm" > __iter__< / span > < span class = "p" > ()< / span > < / code >
< / h3 >
< div class = "doc doc-contents " >
< p > overloading the default function< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 118< / span >
< span class = "normal" > 119< / span >
< span class = "normal" > 120< / span >
< span class = "normal" > 121< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > def< / span > < span class = "fm" > __iter__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > Any< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " overloading the default function" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > for< / span > < span class = "n" > key< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "o" > .< / span > < span class = "n" > keys< / span > < span class = "p" > ():< / span >
< span class = "k" > yield< / span > < span class = "n" > key< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.TokenStore.__setitem__" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "fm" > __setitem__< / span > < span class = "p" > (< / span > < span class = "n" > key< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > )< / span > < / code >
< / h3 >
< div class = "doc doc-contents " >
< p > overloading the default function< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 131< / span >
< span class = "normal" > 132< / span >
< span class = "normal" > 133< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > def< / span > < span class = "fm" > __setitem__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > key< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " overloading the default function" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > [< / span > < span class = "n" > key< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > value< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.TokenStore.load" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "n" > load< / span > < span class = "p" > (< / span > < span class = "n" > overwrite< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > ,< / span > < span class = "n" > filepath< / span > < span class = "o" > =< / span > < span class = "n" > TOKEN_PATH< / span > < span class = "p" > )< / span > < / code >
< / h3 >
< div class = "doc doc-contents " >
< p > Loads the tokens from from the store and caches them in memory - by default
from the local user's store path, but you can point it at any file path.< / p >
< p > Will return the current cached store.< / p >
< p > If overwrite=False, then it will add them to the existing in-memory store< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 143< / span >
< span class = "normal" > 144< / span >
< span class = "normal" > 145< / span >
< span class = "normal" > 146< / span >
< span class = "normal" > 147< / span >
< span class = "normal" > 148< / span >
< span class = "normal" > 149< / span >
< span class = "normal" > 150< / span >
< span class = "normal" > 151< / span >
< span class = "normal" > 152< / span >
< span class = "normal" > 153< / span >
< span class = "normal" > 154< / span >
< span class = "normal" > 155< / span >
< span class = "normal" > 156< / span >
< span class = "normal" > 157< / span >
< span class = "normal" > 158< / span >
< span class = "normal" > 159< / span >
< span class = "normal" > 160< / span >
< span class = "normal" > 161< / span >
< span class = "normal" > 162< / span >
< span class = "normal" > 163< / span >
< span class = "normal" > 164< / span >
< span class = "normal" > 165< / span >
< span class = "normal" > 166< / span >
< span class = "normal" > 167< / span >
< span class = "normal" > 168< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > def< / span > < span class = "nf" > load< / span > < span class = "p" > (< / span >
< span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > overwrite< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > ,< / span > < span class = "n" > filepath< / span > < span class = "p" > :< / span > < span class = "n" > Path< / span > < span class = "o" > =< / span > < span class = "n" > TOKEN_PATH< / span >
< span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > str< / span > < span class = "p" > ]:< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " Loads the tokens from from the store and caches them in memory - by default< / span >
2022-10-07 11:23:12 +02:00
< span class = "sd" > from the local user' s store path, but you can point it at any file path.< / span >
< span class = "sd" > Will return the current cached store.< / span >
< span class = "sd" > If overwrite=False, then it will add them to the existing in-memory store" " " < / span >
< span class = "n" > token_path< / span > < span class = "o" > =< / span > < span class = "n" > filepath< / span > < span class = "o" > .< / span > < span class = "n" > expanduser< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > resolve< / span > < span class = "p" > ()< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > token_path< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > ():< / span >
< span class = "n" > tokens< / span > < span class = "p" > :< / span > < span class = "n" > Dict< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > {}< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "k" > with< / span > < span class = "n" > token_path< / span > < span class = "o" > .< / span > < span class = "n" > open< / span > < span class = "p" > (< / span > < span class = "n" > encoding< / span > < span class = "o" > =< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > )< / span > < span class = "k" > as< / span > < span class = "n" > file_handle< / span > < span class = "p" > :< / span >
< span class = "n" > tokens< / span > < span class = "o" > =< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > load< / span > < span class = "p" > (< / span > < span class = "n" > file_handle< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > overwrite< / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "o" > =< / span > < span class = "n" > tokens< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "k" > for< / span > < span class = "n" > user< / span > < span class = "ow" > in< / span > < span class = "n" > tokens< / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > [< / span > < span class = "n" > user< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > tokens< / span > < span class = "p" > [< / span > < span class = "n" > user< / span > < span class = "p" > ]< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > validate_tokens< / span > < span class = "p" > ()< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > dumps< / span > < span class = "p" > (< / span > < span class = "n" > tokens< / span > < span class = "p" > ,< / span > < span class = "n" > indent< / span > < span class = "o" > =< / span > < span class = "mi" > 4< / span > < span class = "p" > ))< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.TokenStore.save" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "n" > save< / span > < span class = "p" > (< / span > < span class = "n" > filepath< / span > < span class = "o" > =< / span > < span class = "n" > TOKEN_PATH< / span > < span class = "p" > )< / span > < / code >
< / h3 >
< div class = "doc doc-contents " >
< p > saves the cached tokens to disk< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 135< / span >
< span class = "normal" > 136< / span >
< span class = "normal" > 137< / span >
< span class = "normal" > 138< / span >
< span class = "normal" > 139< / span >
< span class = "normal" > 140< / span >
< span class = "normal" > 141< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > def< / span > < span class = "nf" > save< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > filepath< / span > < span class = "p" > :< / span > < span class = "n" > Path< / span > < span class = "o" > =< / span > < span class = "n" > TOKEN_PATH< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " saves the cached tokens to disk" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > dumps< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > ,< / span > < span class = "n" > indent< / span > < span class = "o" > =< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span >
< span class = "k" > with< / span > < span class = "n" > filepath< / span > < span class = "o" > .< / span > < span class = "n" > expanduser< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > resolve< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > open< / span > < span class = "p" > (< / span >
< span class = "n" > mode< / span > < span class = "o" > =< / span > < span class = "s2" > " w" < / span > < span class = "p" > ,< / span > < span class = "n" > encoding< / span > < span class = "o" > =< / span > < span class = "s2" > " utf-8" < / span >
< span class = "p" > )< / span > < span class = "k" > as< / span > < span class = "n" > file_handle< / span > < span class = "p" > :< / span >
< span class = "n" > file_handle< / span > < span class = "o" > .< / span > < span class = "n" > write< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > )< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.TokenStore.token_info" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "n" > token_info< / span > < span class = "p" > (< / span > < span class = "n" > username< / span > < span class = "p" > )< / span > < / code >
< / h3 >
< div class = "doc doc-contents " >
< p > grabs a token and returns a complex object object< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 179< / span >
< span class = "normal" > 180< / span >
< span class = "normal" > 181< / span >
< span class = "normal" > 182< / span >
< span class = "normal" > 183< / span >
< span class = "normal" > 184< / span >
< span class = "normal" > 185< / span >
< span class = "normal" > 186< / span >
< span class = "normal" > 187< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > def< / span > < span class = "nf" > token_info< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > username< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > JWSPayload< / span > < span class = "p" > ]:< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " grabs a token and returns a complex object object" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > if< / span > < span class = "n" > username< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "p" > :< / span >
< span class = "k" > return< / span > < span class = "kc" > None< / span >
< span class = "n" > parsed_object< / span > < span class = "o" > =< / span > < span class = "n" > JsonWebSignature< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > deserialize_compact< / span > < span class = "p" > (< / span >
< span class = "n" > s< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "p" > [< / span > < span class = "n" > username< / span > < span class = "p" > ],< / span > < span class = "n" > key< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span >
< span class = "p" > )< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "n" > parsed_object< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > JWSPayload< / span > < span class = "o" > .< / span > < span class = "n" > parse_raw< / span > < span class = "p" > (< / span > < span class = "n" > parsed_object< / span > < span class = "o" > .< / span > < span class = "n" > payload< / span > < span class = "p" > )< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< div class = "doc doc-object doc-function" >
< h3 id = "kanidm.tokens.TokenStore.validate_tokens" class = "doc doc-heading" >
< code class = "highlight language-python" > < span class = "n" > validate_tokens< / span > < span class = "p" > ()< / span > < / code >
< / h3 >
< div class = "doc doc-contents " >
< p > validates the JWS tokens for format, not their signature - PRs welcome< / p >
< details class = "quote" >
< summary > Source code in < code > kanidm/tokens.py< / code > < / summary >
< div class = "highlight" > < table class = "highlighttable" > < tr > < td class = "linenos" > < div class = "linenodiv" > < pre > < span > < / span > < span class = "normal" > 170< / span >
< span class = "normal" > 171< / span >
< span class = "normal" > 172< / span >
< span class = "normal" > 173< / span >
< span class = "normal" > 174< / span >
< span class = "normal" > 175< / span >
< span class = "normal" > 176< / span >
< span class = "normal" > 177< / span > < / pre > < / div > < / td > < td class = "code" > < div > < pre > < span > < / span > < code > < span class = "k" > def< / span > < span class = "nf" > validate_tokens< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
2023-01-08 23:35:11 +01:00
< span class = "w" > < / span > < span class = "sd" > " " " validates the JWS tokens for format, not their signature - PRs welcome" " " < / span >
2022-10-07 11:23:12 +02:00
< span class = "k" > for< / span > < span class = "n" > username< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > __root__< / span > < span class = "p" > :< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " Parsing < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > username< / span > < span class = "p" > )< / span >
< span class = "c1" > # TODO: Work out how to get the validation working. We probably shouldn' t be worried about this since we' re using it for auth...< / span >
< span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span >
< span class = "n" > JsonWebSignature< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > deserialize_compact< / span > < span class = "p" > (< / span > < span class = "n" > s< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "p" > [< / span > < span class = "n" > username< / span > < span class = "p" > ],< / span > < span class = "n" > key< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< span class = "p" > )< / span >
< / code > < / pre > < / div > < / td > < / tr > < / table > < / div >
< / details >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
2023-02-17 08:24:03 +01:00
< script id = "__config" type = "application/json" > { "base" : ".." , "features" : [ ] , "search" : "../assets/javascripts/workers/search.db81ec45.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } } < / script >
2022-10-07 11:23:12 +02:00
2023-02-17 08:24:03 +01:00
< script src = "../assets/javascripts/bundle.4b2c34cd.min.js" > < / script >
2022-10-07 11:23:12 +02:00
< / body >
< / html >
