Class SecurityExtensions
Inheritance
Namespace:InfinniPlatform.Security
Assembly:InfinniPlatform.Core.Abstractions.dll
Syntax
public static class SecurityExtensions : object
Methods
| Improve this Doc View SourceAddClaim(IIdentity, String, String)
Добавляет утверждение заданного типа.
Declaration
public static void AddClaim(this IIdentity identity, string claimType, string claimValue)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
System.String | claimValue | Значение утверждения. |
AddOrUpdateClaim(IIdentity, String, String)
Добавляет или обновляет утверждения заданного типа.
Declaration
public static void AddOrUpdateClaim(this IIdentity identity, string claimType, string claimValue)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
System.String | claimValue | Значение утверждения. |
FindAllClaims(IIdentity, String)
Возвращает все утверждения заданного типа.
Declaration
public static IEnumerable<string> FindAllClaims(this IIdentity identity, string claimType)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
Returns
Type | Description |
---|---|
IEnumerable<System.String> | Значения утверждений. |
FindAllClaims<T>(IIdentity, String)
Возвращает все утверждения заданного типа.
Declaration
public static IEnumerable<T> FindAllClaims<T>(this IIdentity identity, string claimType)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
Returns
Type | Description |
---|---|
IEnumerable<T> | Значения утверждений. |
Type Parameters
Name | Description |
---|---|
T | Тип значения утверждения. |
FindFirstClaim(IIdentity, String)
Возвращает первое утверждение заданного типа.
Declaration
public static string FindFirstClaim(this IIdentity identity, string claimType)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
Returns
Type | Description |
---|---|
System.String | Значение утверждения. |
FindFirstClaim<T>(IIdentity, String)
Возвращает первое утверждение заданного типа.
Declaration
public static T FindFirstClaim<T>(this IIdentity identity, string claimType)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
Returns
Type | Description |
---|---|
T | Значение утверждения. |
Type Parameters
Name | Description |
---|---|
T | Тип значения утверждения. |
GetUserId(IIdentity)
Возвращает уникальный идентификатор пользователя.
Declaration
public static string GetUserId(this IIdentity identity)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
Returns
Type | Description |
---|---|
System.String |
HasAllClaims(IIdentity, IEnumerable<String>)
Проверяет наличие всех заданных типов утверждений.
Declaration
public static bool HasAllClaims(this IIdentity identity, IEnumerable<string> claimTypes)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
IEnumerable<System.String> | claimTypes | Типы утверждений (например, |
Returns
Type | Description |
---|---|
System.Boolean |
HasAnyClaims(IIdentity, IEnumerable<String>)
Проверяет наличие любого заданного типа утверждения.
Declaration
public static bool HasAnyClaims(this IIdentity identity, IEnumerable<string> claimTypes)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
IEnumerable<System.String> | claimTypes | Типы утверждений (например, |
Returns
Type | Description |
---|---|
System.Boolean |
HasClaim(IIdentity, String)
Проверяет наличие заданного типа утверждения.
Declaration
public static bool HasClaim(this IIdentity identity, string claimType)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
Returns
Type | Description |
---|---|
System.Boolean |
HasClaim(IIdentity, String, String)
Проверяет наличие заданного типа утверждения.
Declaration
public static bool HasClaim(this IIdentity identity, string claimType, string claimValue)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
System.String | claimValue | Значение утверждения. |
Returns
Type | Description |
---|---|
System.Boolean |
RemoveClaims(IIdentity, String, Func<String, Boolean>)
Удаляет утверждения заданного типа.
Declaration
public static void RemoveClaims(this IIdentity identity, string claimType, Func<string, bool> claimValueMatch = null)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
Func<System.String, System.Boolean> | claimValueMatch | Функция выборки утверждений, которые следует удалить. |
RequiresAllClaims(IHttpServiceBuilder, IEnumerable<String>)
Устанавливает необходимость наличия у пользователя всех заданных типов утверждений.
Declaration
public static void RequiresAllClaims(this IHttpServiceBuilder target, IEnumerable<string> claimTypes)
Parameters
Type | Name | Description |
---|---|---|
IHttpServiceBuilder | target | |
IEnumerable<System.String> | claimTypes |
Remarks
Если пользователь не идентифицирован, клиенту будет возвращен ответ Unauthorized. Если пользователь не имеет всех утверждений заданных типов, клиенту будет возвращен ответ Forbidden.
RequiresAllClaims(IHttpServiceBuilder, String[])
Устанавливает необходимость наличия у пользователя всех заданных типов утверждений.
Declaration
public static void RequiresAllClaims(this IHttpServiceBuilder target, params string[] claimTypes)
Parameters
Type | Name | Description |
---|---|---|
IHttpServiceBuilder | target | |
System.String[] | claimTypes |
Remarks
Если пользователь не идентифицирован, клиенту будет возвращен ответ Unauthorized. Если пользователь не имеет всех утверждений заданных типов, клиенту будет возвращен ответ Forbidden.
RequiresAnyClaims(IHttpServiceBuilder, IEnumerable<String>)
Устанавливает необходимость наличия у пользователя одного из заданных типов утверждений.
Declaration
public static void RequiresAnyClaims(this IHttpServiceBuilder target, IEnumerable<string> claimTypes)
Parameters
Type | Name | Description |
---|---|---|
IHttpServiceBuilder | target | |
IEnumerable<System.String> | claimTypes |
Remarks
Если пользователь не идентифицирован, клиенту будет возвращен ответ Unauthorized. Если пользователь не имеет ни одного утверждения из заданных типов, клиенту будет возвращен ответ Forbidden.
RequiresAnyClaims(IHttpServiceBuilder, String[])
Устанавливает необходимость наличия у пользователя одного из заданных типов утверждений.
Declaration
public static void RequiresAnyClaims(this IHttpServiceBuilder target, params string[] claimTypes)
Parameters
Type | Name | Description |
---|---|---|
IHttpServiceBuilder | target | |
System.String[] | claimTypes |
Remarks
Если пользователь не идентифицирован, клиенту будет возвращен ответ Unauthorized. Если пользователь не имеет ни одного утверждения из заданных типов, клиенту будет возвращен ответ Forbidden.
RequiresAuthentication(IHttpServiceBuilder)
Устанавливает необходимость аутентификации пользователя.
Declaration
public static void RequiresAuthentication(this IHttpServiceBuilder target)
Parameters
Type | Name | Description |
---|---|---|
IHttpServiceBuilder | target |
Remarks
Если пользователь не идентифицирован, клиенту будет возвращен ответ Unauthorized.
RequiresClaim(IHttpServiceBuilder, String)
Устанавливает необходимость наличия у пользователя заданного типа утверждения.
Declaration
public static void RequiresClaim(this IHttpServiceBuilder target, string claimType)
Parameters
Type | Name | Description |
---|---|---|
IHttpServiceBuilder | target | |
System.String | claimType |
Remarks
Если пользователь не идентифицирован, клиенту будет возвращен ответ Unauthorized. Если пользователь не имеет утверждения заданного типа, клиенту будет возвращен ответ Forbidden.
RequiresClaim(IHttpServiceBuilder, String, String)
Устанавливает необходимость наличия у пользователя заданного типа утверждения с заданным значением.
Declaration
public static void RequiresClaim(this IHttpServiceBuilder target, string claimType, string claimValue)
Parameters
Type | Name | Description |
---|---|---|
IHttpServiceBuilder | target | |
System.String | claimType | |
System.String | claimValue |
Remarks
Если пользователь не идентифицирован, клиенту будет возвращен ответ Unauthorized. Если пользователь не имеет утверждения заданного типа с заданным значением, клиенту будет возвращен ответ Forbidden.
RequiresValidUser(IHttpServiceBuilder, Func<IIdentity, Boolean>)
Устанавливает необходимость наличия пользователя, который проходит заданную проверку.
Declaration
public static void RequiresValidUser(this IHttpServiceBuilder target, Func<IIdentity, bool> userMatch)
Parameters
Type | Name | Description |
---|---|---|
IHttpServiceBuilder | target | |
Func<IIdentity, System.Boolean> | userMatch |
Remarks
Если пользователь не идентифицирован, клиенту будет возвращен ответ Unauthorized. Если пользователь не проходит заданную проверку, клиенту будет возвращен ответ Forbidden.
SetClaim(IIdentity, String, String)
Заменяет все утверждения заданного типа.
Declaration
public static void SetClaim(this IIdentity identity, string claimType, string claimValue)
Parameters
Type | Name | Description |
---|---|---|
IIdentity | identity | Объект идентификации. |
System.String | claimType | Тип утверждения (например, |
System.String | claimValue | Значение утверждения. |