Share via

WindowsTokenRoleProvider.IsUserInRole Метод

  • Ссылка

Определение

Пространство имен:
System.Web.Security
Сборка:
System.Web.dll

Возвращает значение, позволяющее определить, может ли заданный пользователь быть в указанной встроенной роли Windows.

Перегрузки

IsUserInRole(String, WindowsBuiltInRole)

Возвращает значение, позволяющее определить, может ли заданный пользователь быть в указанной встроенной роли Windows.
IsUserInRole(String, String)

Возвращает значение, указывающее, является ли указанный пользователь членом группы Windows.

IsUserInRole(String, WindowsBuiltInRole)

Возвращает значение, позволяющее определить, может ли заданный пользователь быть в указанной встроенной роли Windows.

public:
 bool IsUserInRole(System::String ^ username, System::Security::Principal::WindowsBuiltInRole role);
public bool IsUserInRole (string username, System.Security.Principal.WindowsBuiltInRole role);
override this.IsUserInRole : string * System.Security.Principal.WindowsBuiltInRole -> bool
Public Function IsUserInRole (username As String, role As WindowsBuiltInRole) As Boolean

Параметры

username
String

Имя пользователя для поиска в форме "Домен\имя_пользователя".

role
WindowsBuiltInRole

Роль Windows, в которой следует выполнить поиск.

Возвращаемое значение

Boolean

true, если указанный пользователь в указанной роли Windows; в противном случае — false.

Исключения

ArgumentNullException

username имеет значение null.

ProviderException

Текущий пользователь не имеет прошедшего проверку подлинности объекта WindowsIdentity, вложенного в свойство User. Для скриптов, не использующих протокол HTTP, текущий пользователь не имеет прошедшего проверку подлинности объекта WindowsIdentity, вложенного в свойство CurrentPrincipal.

-или-

Параметр username не совпадает со свойством Name текущего объекта WindowsIdentity.

Примеры

В следующем примере кода программными средствами проверяется, находится ли текущий вошедший в систему пользователь в роли "Администраторы", прежде чем разрешить пользователю просматривать сведения о ролях для приложения. Пример файла Web.config, который обеспечивает управление ролями, см. в разделе WindowsTokenRoleProvider.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Security.Principal" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

string[] rolesArray;

public void Page_Load()
{
  Msg.Text = "";

  WindowsPrincipal p = (WindowsPrincipal)System.Threading.Thread.CurrentPrincipal;

  if (!p.IsInRole(WindowsBuiltInRole.Administrator))
  {
    Msg.Text = "You are not authorized to view user roles.";
    return;
  }


  // Bind roles to GridView.

  try
  {
    rolesArray = Roles.GetRolesForUser(User.Identity.Name);
  }
  catch (HttpException e)
  {
    Msg.Text = "There is no current logged on user. Role membership cannot be verified.";
    return;
  }

  UserRolesGrid.DataSource = rolesArray;
  UserRolesGrid.DataBind();

  UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

Dim rolesArray() As String

Public Sub Page_Load()
  Msg.Text = ""

  Dim provider As WindowsTokenRoleProvider = CType(Roles.Provider, WindowsTokenRoleProvider)

  If Not provider.IsUserInRole(User.Identity.Name, _
                               System.Security.Principal.WindowsBuiltInRole.Administrator) Then
    Msg.Text = "You are not authorized to view user roles."
    Return
  End If


  ' Bind roles to GridView.

  Try
    rolesArray = Roles.GetRolesForUser(User.Identity.Name)
  Catch e As HttpException
    Msg.Text = "There is no current logged on user. Role membership cannot be verified."
    Return
  End Try

  UserRolesGrid.DataSource = rolesArray
  UserRolesGrid.DataBind()

  UserRolesGrid.Columns(0).HeaderText = "Roles for " & User.Identity.Name
End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

Комментарии

Этот IsUserInRole метод позволяет проверить, входит ли пользователь в одну из общих Windows ролей, описанных в перечисленииWindowsBuiltInRole. Этот метод полезен для приложений, локализованных на нескольких языках. Эта перегрузка IsUserInRole метода не является частью RoleProvider базового класса и может быть доступна только путем приведения Provider свойства Roles класса в качестве WindowsTokenRoleProvider типа.

Метод можно вызывать IsUserInRole только для текущего пользователя, выполнившего вход, как определено переменной сервера LOGON_USER. Если значение, username указанное в параметре, не является именем пользователя, вошедшего в систему, HttpException возникает исключение.

IsUserInRole метод можно вызывать только для пользователя, выполнившего вход в систему, определяемого переменной сервера LOGON_USER. Текущий пользователь, выполнивший вход, должен быть Windows прошедшим проверку подлинности пользователем. Дополнительные сведения о ASP.NET и проверка подлинности Windows см. в разделе ASP.NET аутентификации.

См. также раздел

Применяется к

IsUserInRole(String, String)

Возвращает значение, указывающее, является ли указанный пользователь членом группы Windows.

public:
 override bool IsUserInRole(System::String ^ username, System::String ^ roleName);
public override bool IsUserInRole (string username, string roleName);
override this.IsUserInRole : string * string -> bool
Public Overrides Function IsUserInRole (username As String, roleName As String) As Boolean

Параметры

username
String

Имя пользователя для поиска в форме "Домен\имя_пользователя".

roleName
String

Группа Windows, в которой необходимо выполнить поиск в форме "Домен\имя_пользователя".

Возвращаемое значение

Boolean

true, если пользователь с указанным именем входит в группу Windows; в противном случае — false.

Исключения

ArgumentNullException

username имеет значение null.

-или-

roleName имеет значение null.

ProviderException

Текущий пользователь не имеет прошедшего проверку подлинности объекта WindowsIdentity, вложенного в свойство User. Для скриптов, не использующих протокол HTTP, текущий пользователь не имеет прошедшего проверку подлинности объекта WindowsIdentity, вложенного в свойство CurrentPrincipal.

-или-

Параметр username не совпадает со свойством Name текущего объекта WindowsIdentity.

-или-

Произошел сбой при попытке извлечения сведений и группе Windows пользователя.

Примеры

В следующем примере кода программными средствами проверяется, находится ли текущий вошедший в систему пользователь в роли "Администраторы", прежде чем разрешить пользователю просматривать сведения о ролях для приложения. Пример файла Web.config, который обеспечивает управление ролями, см. в разделе WindowsTokenRoleProvider.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

string[] rolesArray;

public void Page_Load()
{
  Msg.Text = "";

  try
  {
    if (!Roles.IsUserInRole(User.Identity.Name, @"BUILTIN\Administrators"))
    {
      Msg.Text = "You are not authorized to view user roles.";
      return;
    }
  }
  catch (HttpException e)
  {
    Msg.Text = "There is no current logged on user. Role membership cannot be verified.";
    return;
  }


  // Bind roles to GridView.

  rolesArray = Roles.GetRolesForUser(User.Identity.Name);
  UserRolesGrid.DataSource = rolesArray;
  UserRolesGrid.DataBind();

  UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

Dim rolesArray() As String

Public Sub Page_Load()
  Msg.Text = ""

  Try
    If Not Roles.IsUserInRole(User.Identity.Name, "BUILTIN\Administrators") Then
      Msg.Text = "You are not authorized to view user roles."
      Return
    End If
  Catch e As HttpException
    Msg.Text = "There is no current logged on user. Role membership cannot be verified."
    Return
  End Try

  ' Bind roles to GridView.

  rolesArray = Roles.GetRolesForUser(User.Identity.Name)
  UserRolesGrid.DataSource = rolesArray
  UserRolesGrid.DataBind()

  UserRolesGrid.Columns(0).HeaderText = "Roles for " & User.Identity.Name
End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: View User Roles</title>
</head>
<body>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
    <tr>
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                         <Columns>
                           <asp:TemplateField HeaderText="Roles" >
                             <ItemTemplate>
                               <%# Container.DataItem.ToString() %>
                             </ItemTemplate>
                           </asp:TemplateField>
                         </Columns>
                       </asp:GridView></td>
    </tr>
  </table>

</form>

</body>
</html>

Комментарии

Метод IsUserInRole вызывается классом Roles и IsInRole методом User свойства, чтобы определить, находится ли пользователь в группе Windows. Метод можно вызывать IsUserInRole только для текущего пользователя, выполнившего вход, как определено переменной сервера LOGON_USER. Текущий пользователь, выполнивший вход, должен быть Windows прошедшим проверку подлинности пользователем. Дополнительные сведения о ASP.NET и проверка подлинности Windows см. в разделе ASP.NET аутентификации.

См. также раздел

Применяется к