.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Lemonldap::NG::Portal::Lib::OpenIDConnect 3pm" .TH Lemonldap::NG::Portal::Lib::OpenIDConnect 3pm "2023-03-29" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Lemonldap::NG::Portal::Lib::OpenIDConnect \- Common OpenIDConnect functions .SH "SYNOPSIS" .IX Header "SYNOPSIS" use Lemonldap::NG::Portal::Lib::OpenIDConnect; .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module contains common methods for OpenIDConnect authentication and user information loading .SH "METHODS" .IX Header "METHODS" .SS "loadOPs" .IX Subsection "loadOPs" Load OpenID Connect Providers and \s-1JWKS\s0 data .SS "loadRPs" .IX Subsection "loadRPs" Load OpenID Connect Relying Parties .SS "refreshJWKSdata" .IX Subsection "refreshJWKSdata" Refresh \s-1JWKS\s0 data if needed .SS "getRP" .IX Subsection "getRP" Get Relying Party corresponding to a Client \s-1ID\s0 .SS "getCallbackUri" .IX Subsection "getCallbackUri" Compute callback \s-1URI\s0 .SS "buildAuthorizationCodeAuthnRequest" .IX Subsection "buildAuthorizationCodeAuthnRequest" Build Authentication Request \s-1URI\s0 for Authorization Code Flow .SS "buildAuthorizationCodeAuthnResponse" .IX Subsection "buildAuthorizationCodeAuthnResponse" Build Authentication Response \s-1URI\s0 for Authorization Code Flow .SS "buildImplicitAuthnResponse" .IX Subsection "buildImplicitAuthnResponse" Build Authentication Response \s-1URI\s0 for Implicit Flow .SS "buildHybridAuthnResponse" .IX Subsection "buildHybridAuthnResponse" Build Authentication Response \s-1URI\s0 for Hybrid Flow .SS "getAuthorizationCodeAccessToken" .IX Subsection "getAuthorizationCodeAccessToken" Get Token response with authorization code .SS "checkTokenResponseValidity" .IX Subsection "checkTokenResponseValidity" Check validity of Token Response .SS "getUserInfo" .IX Subsection "getUserInfo" Get UserInfo response .SS "decodeJSON" .IX Subsection "decodeJSON" Convert \s-1JSON\s0 to HashRef .SS "newAuthorizationCode" .IX Subsection "newAuthorizationCode" Generate new Authorization Code session .SS "newAccessToken" .IX Subsection "newAccessToken" Generate new Access Token session .SS "newRefreshToken" .IX Subsection "newRefreshToken" Generate new Refresh Token session .SS "getAuthorizationCode" .IX Subsection "getAuthorizationCode" Get existing Authorization Code session .SS "getAccessToken" .IX Subsection "getAccessToken" Get existing Access Token session .SS "getRefreshToken" .IX Subsection "getRefreshToken" Get existing Refresh Token session .SS "getOpenIDConnectSession" .IX Subsection "getOpenIDConnectSession" Try to recover the OpenID Connect session corresponding to id and return session .SS "storeState" .IX Subsection "storeState" Store information in state database and return .SS "extractState" .IX Subsection "extractState" Extract state information into \f(CW$self\fR .SS "extractJWT" .IX Subsection "extractJWT" Extract parts of a \s-1JWT\s0 .SS "verifyJWTSignature" .IX Subsection "verifyJWTSignature" Check signature of a \s-1JWT\s0 .SS "verifyHash" .IX Subsection "verifyHash" Check value hash .SS "createHash" .IX Subsection "createHash" Create Hash .SS "returnBearerError" .IX Subsection "returnBearerError" Return Bearer error .SS "getEndPointAuthenticationCredentials" .IX Subsection "getEndPointAuthenticationCredentials" Get Client \s-1ID\s0 and Client Secret .SS "getEndPointAccessToken" .IX Subsection "getEndPointAccessToken" Get Access Token .SS "getAttributesListFromClaim" .IX Subsection "getAttributesListFromClaim" Return list of attributes authorized for a claim .SS "buildUserInfoResponseFromId" .IX Subsection "buildUserInfoResponseFromId" Return Hash of UserInfo data from session \s-1ID\s0 .SS "buildUserInfoResponse" .IX Subsection "buildUserInfoResponse" Return Hash of UserInfo data from session object .SS "createJWT" .IX Subsection "createJWT" Return \s-1JWT\s0 .SS "createIDToken" .IX Subsection "createIDToken" Return \s-1ID\s0 Token .SS "getFlowType" .IX Subsection "getFlowType" Return flow type .SS "getIDTokenSub" .IX Subsection "getIDTokenSub" Return sub field of an \s-1ID\s0 Token .SS "getJWTJSONData" .IX Subsection "getJWTJSONData" Return payload of a \s-1JWT\s0 as Hash ref .SS "key2jwks" .IX Subsection "key2jwks" Return \s-1JWKS\s0 representation of a key .SS "buildLogoutRequest" .IX Subsection "buildLogoutRequest" Build Logout Request \s-1URI\s0 .SS "buildLogoutResponse" .IX Subsection "buildLogoutResponse" Build Logout Response \s-1URI\s0 .SS "addRouteFromConf" .IX Subsection "addRouteFromConf" Build a Lemonldap::NG::Common::PSGI::Router route from \s-1OIDC\s0 configuration attribute .SS "validatePKCEChallenge" .IX Subsection "validatePKCEChallenge" Validate \s-1PKCE\s0 code challenge with given code challenge method .SH "SEE ALSO" .IX Header "SEE ALSO" Lemonldap::NG::Portal::AuthOpenIDConnect, Lemonldap::NG::Portal::UserDBOpenIDConnect .SH "AUTHORS" .IX Header "AUTHORS" .IP "LemonLDAP::NG team " 4 .IX Item "LemonLDAP::NG team " .SH "BUG REPORT" .IX Header "BUG REPORT" Use \s-1OW2\s0 system to report bug or ask for features: .SH "DOWNLOAD" .IX Header "DOWNLOAD" Lemonldap::NG is available at .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" See \s-1COPYING\s0 file for details. .PP This library is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program. If not, see .