Adding generation of accessors for equivalent claims #1829
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| <#@ template debug="false" hostspecific="false" language="C#" #> | ||
| <#@ assembly name="System.Core" #> | ||
| <#@ import namespace="System.Linq" #> | ||
| <#@ import namespace="System.Text" #> | ||
| <#@ import namespace="System.Collections.Generic" #> | ||
| <#@ output extension=".gen.cs" #> | ||
| <#@ include file="ClaimsKnowledge.tti" #> | ||
| //------------------------------------------------------------------------------ | ||
| // | ||
| // Copyright (c) Microsoft Corporation. | ||
| // All rights reserved. | ||
| // | ||
| // This code is licensed under the MIT License. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files(the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and / or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions : | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
| // | ||
| //------------------------------------------------------------------------------ | ||
|
|
||
| // THIS FILE IS AUTOMATICALLY GENERATED FROM ClaimsTypeAccessor.tt USING T4 | ||
| // DON'T UPDATE MANUALLY | ||
|
|
||
| using System.Collections.Generic; | ||
| using System.IdentityModel.Tokens.Jwt; | ||
| using System.Security.Claims; | ||
|
|
||
| namespace System.IdentityModel.Aad | ||
| { | ||
| /// <summary> | ||
| /// Defines extension methods to access claims by purpose, and not by name, making it compatible | ||
| /// with several versions of tokens. | ||
| /// </summary> | ||
| public static partial class ClaimPrincipalExtensions | ||
| { | ||
| <# | ||
| foreach(ClaimsKnowledge c in claimsKnowledge) | ||
| { | ||
| if (c.HasMultipleInstances) | ||
| { | ||
| #> | ||
| /// <summary> | ||
| /// Returns all the claims corresponding to <#=c.AccessorName#> on a ClaimsPrincipal: | ||
| /// <list type="bullet"> | ||
| <# | ||
| foreach(string s in c.AllClaimNames) | ||
| { | ||
| #> | ||
| /// <item><description><#= s #></description></item> | ||
| <# | ||
| } | ||
| #> | ||
| /// </list> | ||
| /// This method returns information that is <#= c.IsUsableInAuthorizationPolicies ? string.Empty : "NOT " #>safe to use for authorization. | ||
| <# | ||
| if (!string.IsNullOrEmpty(c.PrivacyCategory)) | ||
| { | ||
| #> | ||
| /// The privacy classification of the information returned is <#= c.PrivacyCategory #>. | ||
| <# | ||
| } | ||
| #> | ||
| /// </summary> | ||
| /// <param name="claimsPrincipal">Claims principal from which to get the <#=c.AccessorName#>.</param> | ||
| public static IEnumerable<string> Get<#=c.AccessorName#>(this ClaimsPrincipal claimsPrincipal) | ||
| { | ||
| if (claimsPrincipal == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(claimsPrincipal)); | ||
| } | ||
| return claimsPrincipal.GetAllClaimValues( | ||
| <#=string.Join(",\n ", c.AllClaimNames)#>); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns all the claims corresponding to <#=c.AccessorName#> on a ClaimsPrincipal: | ||
| /// <list type="bullet"> | ||
| <# | ||
| foreach(string s in c.AllClaimNames) | ||
| { | ||
| #> | ||
| /// <item><description><#= s #></description></item> | ||
| <# | ||
| } | ||
| #> | ||
| /// </list> | ||
| /// This method returns information that is <#= c.IsUsableInAuthorizationPolicies ? string.Empty : "NOT " #>safe to use for authorization. | ||
| <# | ||
| if (!string.IsNullOrEmpty(c.PrivacyCategory)) | ||
| { | ||
| #> | ||
| /// The privacy classification of the information returned is <#= c.PrivacyCategory #>. | ||
| <# | ||
| } | ||
| #> | ||
| /// </summary> | ||
| /// <param name="claimsIdentity">Claims ClaimsIdentity from which to get the <#=c.AccessorName#>.</param> | ||
| public static IEnumerable<string> Get<#=c.AccessorName#>(this ClaimsIdentity claimsIdentity) | ||
| { | ||
| if (claimsIdentity == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(claimsIdentity)); | ||
| } | ||
| return claimsIdentity.GetAllClaimValues( | ||
| <#=string.Join(",\n ", c.AllClaimNames)#>); | ||
| } | ||
|
|
||
| <# | ||
| } | ||
| else | ||
| { | ||
| #> | ||
| /// <summary> | ||
| /// Returns the first claim corresponding to <#=c.AccessorName#> claim on a ClaimsPrincipal | ||
| /// <list type="bullet"> | ||
| <# | ||
| foreach(string s in c.AllClaimNames) | ||
| { | ||
| #> | ||
| /// <item><description><#= s #></description></item> | ||
| <# | ||
| } | ||
| #> | ||
| /// </list> | ||
| /// This method returns information that is <#= c.IsUsableInAuthorizationPolicies ? string.Empty : "NOT " #>safe to use for authorization. | ||
| <# | ||
| if (!string.IsNullOrEmpty(c.PrivacyCategory)) | ||
| { | ||
| #> | ||
| /// The privacy classification of the information returned is <#= c.PrivacyCategory #>. | ||
| <# | ||
| } | ||
| #> | ||
| /// </summary> | ||
| /// <param name="claimsPrincipal">Claims ClaimsPrincipal from which to get the <#=c.AccessorName#>.</param> | ||
| public static string Get<#=c.AccessorName#>(this ClaimsPrincipal claimsPrincipal) | ||
| { | ||
| if (claimsPrincipal == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(claimsPrincipal)); | ||
| } | ||
| return claimsPrincipal.GetClaimValue( | ||
| <#=string.Join(",\n ", c.AllClaimNames)#>); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns the first claim corresponding to <#=c.AccessorName#> claim on a ClaimsIdentity | ||
| /// <list type="bullet"> | ||
| <# | ||
| foreach(string s in c.AllClaimNames) | ||
| { | ||
| #> | ||
| /// <item><description><#= s #></description></item> | ||
| <# | ||
| } | ||
| #> | ||
| /// </list> | ||
| /// This method returns information that is <#= c.IsUsableInAuthorizationPolicies ? string.Empty : "NOT " #>safe to use for authorization. | ||
| <# | ||
| if (!string.IsNullOrEmpty(c.PrivacyCategory)) | ||
| { | ||
| #> | ||
| /// The privacy classification of the information returned is <#= c.PrivacyCategory #>. | ||
| <# | ||
| } | ||
| #> | ||
| /// </summary> | ||
| /// <param name="claimsIdentity">Claims ClaimsIdentity from which to get the <#=c.AccessorName#>.</param> | ||
| public static string Get<#=c.AccessorName#>(this ClaimsIdentity claimsIdentity) | ||
| { | ||
| if (claimsIdentity == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(claimsIdentity)); | ||
| } | ||
| return claimsIdentity.GetClaimValue( | ||
| <#=string.Join(",\n ", c.AllClaimNames)#>); | ||
| } | ||
| <# | ||
| } | ||
| } | ||
| #> | ||
|
|
||
|
|
||
| private static Dictionary<string, string[]> equivalentClaims = new Dictionary<string, string[]> | ||
| { | ||
| <# | ||
| foreach(ClaimsKnowledge c in claimsKnowledge) | ||
| { | ||
| foreach(string claim in c.AllClaimNames) | ||
| { | ||
| #> | ||
| { <#=claim#>, new string[]{ <#= string.Join(", ", c.AllClaimNames) #> } }, | ||
| <# | ||
| } | ||
| } | ||
| #> | ||
| }; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| | ||
| # Claims | ||
|
|
||
| Type | Accessor | Used for authorization | Privacy | Claims | ||
| -- | -- | -- | -- | -- | ||
| string | GetActor | False | | actort<BR/> http://schemas.xmlsoap.org/ws/2009/09/identity/claims/actor | ||
| string | GetIsGuestAccount | True | | acct | ||
| string | GetLastAuthenticatedTime | False | | auth_time | ||
| string | GetBirthdate | False | EUII | birthdate<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/dateofbirth | ||
| string | GetCountry | False | EUII | ctry | ||
| string | GetEmail | False | EUII | email<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress | ||
| string | GetFamilyName | False | EUII | family_name<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname | ||
| string | GetGender | False | EUII | gender<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/gender | ||
| string | GetGivenName | False | EUII | given_name<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname | ||
| string | GetNameId | False | | nameid<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier | ||
| string | GetSubject | False | | sub<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier | ||
| string | GetWebsite | False | | website<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/webpage | ||
| string | GetUniqueName | False | EUPI | unique_name<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | ||
| string | GetObjectId | True | EUPI | oid<BR/> http://schemas.microsoft.com/identity/claims/objectidentifier | ||
| IEnumerable<string> | GetScopes | True | | scp<BR/> http://schemas.microsoft.com/identity/claims/scope | ||
| string | GetTenantId | True | OII | tid<BR/> http://schemas.microsoft.com/identity/claims/tenantid | ||
| string | GetAuthenticationContextClassReference | False | | acr<BR/> http://schemas.microsoft.com/claims/authnclassreference | ||
| string | GetAdfs1Email | False | EUPI | adfs1email<BR/> http://schemas.xmlsoap.org/claims/EmailAddress | ||
| string | GetAdfs1Upn | False | EUPI | adfs1upn<BR/> http://schemas.xmlsoap.org/claims/UPN | ||
| string | GetAmr | False | | amr<BR/> http://schemas.microsoft.com/claims/authnmethodsreferences | ||
|
There was a problem hiding this comment. amr is definitely used in Authorization as this defines how the subject authenticated with the identity provider. |
||
| string | GetAuthenticationMethod | False | | authmethod<BR/> http://schemas.microsoft.com/ws/2008/06/identity/claims/authenticationmethod | ||
| string | GetCertAppPolicy | False | | certapppolicy<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/applicationpolicy | ||
| string | GetCertAuthorityKeyIdentifier | False | | certauthoritykeyidentifier<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/authoritykeyidentifier | ||
| string | GetCertBasicConstraints | False | | certbasicconstraints<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/basicconstraints | ||
| string | GetCertEku | False | | certeku<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/eku | ||
| string | GetCertIssuer | False | | certissuer<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/field/issuer | ||
| string | GetCertIssuerName | False | | certissuername<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/field/issuername | ||
| string | GetCertKeyUsage | False | | certkeyusage<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/keyusage | ||
| string | GetCertNotAfter | False | | certnotafter<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/field/notafter | ||
| string | GetCertNotBefore | False | | certnotbefore<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/field/notbefore | ||
| string | GetCertPolicy | False | | certpolicy<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/certificatepolicy | ||
| string | GetCertPublickey | False | | certpublickey<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/rsa | ||
| string | GetCertRawData | False | | certrawdata<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/field/rawdata | ||
| string | GetCertSerialNumber | False | | certserialnumber<BR/> http://schemas.microsoft.com/ws/2008/06/identity/claims/serialnumber | ||
| string | GetCertSignatureAlgorithm | False | | certsignaturealgorithm<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/field/signaturealgorithm | ||
| string | GetCertSubject | False | | certsubject<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/field/subject | ||
| string | GetCertSubjectAltName | False | | certsubjectaltname<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/san | ||
| string | GetCertSubjectKeyIdentifier | False | | certsubjectkeyidentifier<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/subjectkeyidentifier | ||
| string | GetCertSubjectName | False | | certsubjectname<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/field/subjectname | ||
| string | GetCertTemplateInformation | False | | certtemplateinformation<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/certificatetemplateinformation | ||
| string | GetCertTemplateName | False | | certtemplatename<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/extension/certificatetemplatename | ||
| string | GetCertThumbprint | False | | certthumbprint<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint | ||
| string | GetCertX509Version | False | | certx509version<BR/> http://schemas.microsoft.com/2012/12/certificatecontext/field/x509version | ||
| string | GetClientApplication | True | | clientapplication<BR/> http://schemas.microsoft.com/2012/01/requestcontext/claims/x-ms-client-application | ||
| string | GetClientIp | False | EUPI | clientip<BR/> http://schemas.microsoft.com/2012/01/requestcontext/claims/x-ms-client-ip | ||
| string | GetClientUserAgent | False | | clientuseragent<BR/> http://schemas.microsoft.com/2012/01/requestcontext/claims/x-ms-client-user-agent | ||
| string | GetCommonName | False | EUPI | commonname<BR/> http://schemas.xmlsoap.org/claims/CommonName | ||
| string | GetDenyOnlyPrimaryGroupSid | False | | denyonlyprimarygroupsid<BR/> http://schemas.microsoft.com/ws/2008/06/identity/claims/denyonlyprimarygroupsid | ||
| string | GetDenyOnlyPrimarySid | False | | denyonlyprimarysid<BR/> http://schemas.microsoft.com/ws/2008/06/identity/claims/denyonlyprimarysid | ||
| string | GetDenyOnlySid | False | | denyonlysid<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/denyonlysid | ||
| string | GetDeviceDisplayName | False | | devicedispname<BR/> http://schemas.microsoft.com/2012/01/devicecontext/claims/displayname | ||
| string | GetDeviceId | False | | deviceid<BR/> http://schemas.microsoft.com/2012/01/devicecontext/claims/identifier | ||
| string | GetDeviceIsManaged | False | | deviceismanaged<BR/> http://schemas.microsoft.com/2012/01/devicecontext/claims/ismanaged | ||
| string | GetDeviceOsType | False | | deviceostype<BR/> http://schemas.microsoft.com/2012/01/devicecontext/claims/ostype | ||
| string | GetDeviceOsVer | False | | deviceosver<BR/> http://schemas.microsoft.com/2012/01/devicecontext/claims/osversion | ||
| string | GetDeviceOwner | False | EUPI | deviceowner<BR/> http://schemas.microsoft.com/2012/01/devicecontext/claims/userowner | ||
| string | GetDeviceRegId | False | | deviceregid<BR/> http://schemas.microsoft.com/2012/01/devicecontext/claims/registrationid | ||
| string | GetEndpointPath | False | | endpointpath<BR/> http://schemas.microsoft.com/2012/01/requestcontext/claims/x-ms-endpoint-absolute-path | ||
| string | GetForwardedClientIp | False | | forwardedclientip<BR/> http://schemas.microsoft.com/2012/01/requestcontext/claims/x-ms-forwarded-client-ip | ||
| IEnumerable<string> | GetGroup | False | | group<BR/> http://schemas.xmlsoap.org/claims/Group | ||
| IEnumerable<string> | GetGroupsId | False | | groupsid<BR/> http://schemas.microsoft.com/ws/2008/06/identity/claims/groupsid | ||
| string | GetTokenType | False | | idtyp | ||
| string | GetIdp | True | | idp<BR/> http://schemas.microsoft.com/identity/claims/identityprovider | ||
| string | GetInsideCorporateNetwork | True | | insidecorporatenetwork<BR/> http://schemas.microsoft.com/ws/2012/01/insidecorporatenetwork | ||
| string | GetIsRegisteredUser | True | | isregistereduser<BR/> http://schemas.microsoft.com/2012/01/devicecontext/claims/isregistereduser | ||
| string | GetLoginHint | False | | login_hint | ||
| string | GetPrivatePersonalIdentifier | False | EUPI | ppid<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/privatepersonalidentifier | ||
| string | GetPrimaryGroupSid | True | | primarygroupsid<BR/> http://schemas.microsoft.com/ws/2008/06/identity/claims/primarygroupsid | ||
| string | GetPrimarySid | True | | primarysid<BR/> http://schemas.microsoft.com/ws/2008/06/identity/claims/primarysid | ||
| string | GetProxy | False | | proxy<BR/> http://schemas.microsoft.com/2012/01/requestcontext/claims/x-ms-proxy | ||
| string | GetPwdChgEndpoint | False | | pwdchgurl<BR/> http://schemas.microsoft.com/ws/2012/01/passwordchangeurl | ||
| string | GetPwdExpDays | False | | pwdexpdays<BR/> http://schemas.microsoft.com/ws/2012/01/passwordexpirationdays | ||
| string | GetPwdExpTime | False | | pwdexptime<BR/> http://schemas.microsoft.com/ws/2012/01/passwordexpirationtime | ||
| string | GetRelyingPartyTrustId | False | | relyingpartytrustid<BR/> http://schemas.microsoft.com/2012/01/requestcontext/claims/relyingpartytrustid | ||
| IEnumerable<string> | GetRole | True | | role<BR/> roles<BR/> http://schemas.microsoft.com/ws/2008/06/identity/claims/role | ||
| string | GetSid | True | | sid | ||
| string | GetUpn | False | EUPI | upn<BR/> http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn | ||
| string | GetWindowsAccountName | False | EUPI | winaccountname<BR/> http://schemas.microsoft.com/ws/2008/06/identity/claims/windowsaccountname | ||
| string | GetVerifiedPrimaryEmail | False | EUPI | verified_primary_email | ||
| string | GetVerifiedSecondaryEmail | False | EUPI | verified_secondary_email | ||
| string | GetVNet | False | | vnet | ||
| string | GetPreferedDataLocation | False | | xms_pdl | ||
| string | GetUserPreferedLanguage | False | | xms_tpl | ||
| string | GetZeroTouchDeploymentId | False | | ztdid | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think actor is PII as the return is another token.