| 1 | package Mojo::SAML::Names; | ||
| 2 | |||
| 3 | use Mojo::Base -strict; | ||
| 4 | use Carp (); | ||
| 5 | use Exporter 'import'; | ||
| 6 | |||
| 7 | our @EXPORT_OK = (qw/attrname_format binding nameid_format/); | ||
| 8 | |||
| 9 | my %attrname_format_aliases = ( | ||
| 10 | unspecified => 'urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified', | ||
| 11 | uri => 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri', | ||
| 12 | basic => 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic', | ||
| 13 | ); | ||
| 14 | my @attrname_formats = values %attrname_format_aliases; | ||
| 15 | my %valid_attrname_formats; @valid_attrname_formats{@attrname_formats} = (1) x @attrname_formats; | ||
| 16 | |||
| 17 | sub attrname_format { | ||
| 18 | my ($in, $lax) = @_; | ||
| 19 | return $attrname_format_aliases{$in} if exists $attrname_format_aliases{$in}; | ||
| 20 | return $in if $valid_attrname_formats{$in} || $lax; | ||
| 21 | Carp::croak "$in is not a valid attrname format (or alias)"; | ||
| 22 | } | ||
| 23 | |||
| 24 | my %binding_aliases = ( | ||
| 25 | SOAP => 'urn:oasis:names:tc:SAML:2.0:bindings:SOAP', | ||
| 26 | 'HTTP-Redirect' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect', | ||
| 27 | 'HTTP-POST' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', | ||
| 28 | ); | ||
| 29 | my @bindings = values %binding_aliases; | ||
| 30 | my %valid_bindings; @valid_bindings{@bindings} = (1) x @bindings; | ||
| 31 | |||
| 32 | sub binding { | ||
| 33 | my ($in, $lax) = @_; | ||
| 34 | return $binding_aliases{$in} if exists $binding_aliases{$in}; | ||
| 35 | return $in if $valid_bindings{$in} || $lax; | ||
| 36 | Carp::croak "$in is not a valid binding (or alias)"; | ||
| 37 | } | ||
| 38 | |||
| 39 | my %nameid_format_aliases = ( | ||
| 40 | unspecified => 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified', | ||
| 41 | emailAddress => 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', | ||
| 42 | X509SubjectName => 'urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName', | ||
| 43 | WindowsDomainQualifiedName => 'urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName', | ||
| 44 | kerberos => 'urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos', | ||
| 45 | entity => 'urn:oasis:names:tc:SAML:2.0:nameid-format:entity', | ||
| 46 | persistent => 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent', | ||
| 47 | transient => 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient', | ||
| 48 | ); | ||
| 49 | my @nameid_formats = values %binding_aliases; | ||
| 50 | my %valid_nameid_formats; @valid_nameid_formats{@nameid_formats} = (1) x @nameid_formats; | ||
| 51 | |||
| 52 | sub nameid_format { | ||
| 53 | my ($in, $lax) = @_; | ||
| 54 | return $nameid_format_aliases{$in} if exists $nameid_format_aliases{$in}; | ||
| 55 | return $in if $valid_nameid_formats{$in} || $lax; | ||
| 56 | Carp::croak "$in is not a valid nameid format"; | ||
| 57 | } | ||
| 58 | |||
| 59 | 1; | ||
| 60 | |||
| 61 | =head1 NAME | ||
| 62 | |||
| 63 | Mojo::SAML::Names - Functions that qualify shortened names | ||
| 64 | |||
| 65 | =head1 DESCRIPTION | ||
| 66 | |||
| 67 | There are several types of names that come in fully qualified form that are too verbose for day to day use. | ||
| 68 | This modules contains functions that provide qualified version of from short names. | ||
| 69 | |||
| 70 | =head1 FUNCTIONS | ||
| 71 | |||
| 72 | L<Mojo::SAML::Names> exports no functions by default but exports any of the following upon request. | ||
| 73 | |||
| 74 | =head2 attrname_format | ||
| 75 | |||
| 76 | $name = attrname_format($name); | ||
| 77 | $name = attrname_format($name, $lax); | ||
| 78 | |||
| 79 | Qualify an attrname format used by SAML. | ||
| 80 | Given a short or qualified name return the qualified name. | ||
| 81 | If the fully qualified name is not known the function throws an exception unless the lax flag is true. | ||
| 82 | |||
| 83 | unspecified => 'urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified' | ||
| 84 | uri => 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri' | ||
| 85 | basic => 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic' | ||
| 86 | |||
| 87 | =head2 binding | ||
| 88 | |||
| 89 | $name = binding($name); | ||
| 90 | $name = binding($name, $lax); | ||
| 91 | |||
| 92 | Qualify a binding used by SAML. | ||
| 93 | Given a short or qualified name return the qualified name. | ||
| 94 | If the fully qualified name is not known the function throws an exception unless the lax flag is true. | ||
| 95 | |||
| 96 | SOAP => 'urn:oasis:names:tc:SAML:2.0:bindings:SOAP' | ||
| 97 | 'HTTP-Redirect' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect' | ||
| 98 | 'HTTP-POST' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST' | ||
| 99 | |||
| 100 | =head2 nameid_format | ||
| 101 | |||
| 102 | $name = nameid_format($name); | ||
| 103 | $name = nameid_format($name, $lax); | ||
| 104 | |||
| 105 | Qualify a nameid format used by SAML. | ||
| 106 | Given a short or qualified name return the qualified name. | ||
| 107 | If the fully qualified name is not known the function throws an exception unless the lax flag is true. | ||
| 108 | |||
| 109 | unspecified => 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified' | ||
| 110 | emailAddress => 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress' | ||
| 111 | X509SubjectName => 'urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName' | ||
| 112 | WindowsDomainQualifiedName => 'urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName' | ||
| 113 | kerberos => 'urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos' | ||
| 114 | entity => 'urn:oasis:names:tc:SAML:2.0:nameid-format:entity' | ||
| 115 | persistent => 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent' | ||
| 116 | transient => 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient' | ||
| 117 | |||
| 118 |