LdapUser.cs

// <copyright file="LdapUser.cs" company="Visualisierungsinstitut der Universität Stuttgart">
// Copyright © 2021 - 2024 Visualisierungsinstitut der Universität Stuttgart.
// Licensed under the MIT licence. See LICENCE file for details.
// </copyright>
// <author>Christoph Müller</author>

using System.Collections.Generic;
using System.Diagnostics;
using System.Security.Claims;
using Visus.Ldap.Claims;
using Visus.Ldap.Mapping;


namespace Visus.Ldap {

    /// <summary>
    /// The basic representation of a user from LDAP.
    /// </summary>
    /// <remarks>
    /// <para>This class provides mappings for LDAP attributes typically used
    /// for authenticating users along with <see cref="Groups"/> that might be
    /// mapped to roles.</para>
    /// <para>If you need additional data from the directory, you can derive
    /// from this class and add these properties with appropriate attributes.
    /// Make sure to use the attribute-based mapper in this case as the
    /// performance-optimised ones derived from
    /// <see cref="DefaultMapperBase{TEntry}"/> only fill the properties
    /// in this class, but not the ones you may have added.</para>
    /// <para>Note to implementors: When changing this class, make sure to
    /// reflect the hard-coded assignments of properties in
    /// <see cref="DefaultMapperBase{TEntry}.MapUser(TEntry, LdapUser)"/>.
    /// </para>
    /// </remarks>
    [DebuggerDisplay("{AccountName}")]
    public class LdapUser {

        #region Public properties
        /// <summary>
        /// Gets the unique account name of the user.
        /// </summary>
        [LdapAttribute(Schema.ActiveDirectory, "sAMAccountName")]
        [LdapAttribute(Schema.IdentityManagementForUnix, "sAMAccountName")]
        [LdapAttribute(Schema.Rfc2307, "uid")]
        [Claim(ClaimTypes.Name)]
        [Claim(ClaimTypes.WindowsAccountName)]
        [AccountName]
        public string AccountName { get; set; } = null!;

        /// <summary>
        /// Gets the Christian name of the user.
        /// </summary>
        [LdapAttribute(Schema.ActiveDirectory, "givenName")]
        [LdapAttribute(Schema.IdentityManagementForUnix, "givenName")]
        [LdapAttribute(Schema.Rfc2307, "givenName")]
        [Claim(ClaimTypes.GivenName)]
        public string? ChristianName { get; set; }

        /// <summary>
        /// Gets the display name of the user.
        /// </summary>
        [LdapAttribute(Schema.ActiveDirectory, "displayName")]
        [LdapAttribute(Schema.IdentityManagementForUnix, "displayName")]
        [LdapAttribute(Schema.Rfc2307, "displayName")]
        public string? DisplayName { get; set; }

        /// <summary>
        /// Gets the distinguished name of the user.
        /// </summary>
        [LdapAttribute(Schema.ActiveDirectory, "distinguishedName")]
        [LdapAttribute(Schema.IdentityManagementForUnix, "distinguishedName")]
        [LdapAttribute(Schema.Rfc2307, "distinguishedName")]
        [DistinguishedName]
        public string DistinguishedName { get; set; } = null!;

        /// <summary>
        /// Gets the e-mail address of the user.
        /// </summary>
        [LdapAttribute(Schema.ActiveDirectory, "mail")]
        [LdapAttribute(Schema.IdentityManagementForUnix, "mail")]
        [LdapAttribute(Schema.Rfc2307, "mail")]
        [Claim(ClaimTypes.Email)]
        public string? EmailAddress { get; set; }

        /// <summary>
        /// Gets the groups the user is member of.
        /// </summary>
        [GroupMemberships]
        public IEnumerable<LdapGroup> Groups { get; internal set; } = null!;

        /// <summary>
        /// Gets the security identifier of the user.
        /// </summary>
        [LdapAttribute(Schema.ActiveDirectory, "objectSid",
            Converter = typeof(SidConverter))]
        [LdapAttribute(Schema.IdentityManagementForUnix, "uidNumber")]
        [LdapAttribute(Schema.Rfc2307, "uidNumber")]
        [Claim(ClaimTypes.PrimarySid)]
        [Claim(ClaimTypes.Sid)]
        [Claim(ClaimTypes.NameIdentifier)]
        [Identity]
        public string Identity { get; set; } = null!;

        /// <summary>
        /// Gets the surname of the user.
        /// </summary>
        [LdapAttribute(Schema.ActiveDirectory, "sn")]
        [LdapAttribute(Schema.IdentityManagementForUnix, "sn")]
        [LdapAttribute(Schema.Rfc2307, "sn")]
        [Claim(ClaimTypes.Surname)]
        public string? Surname { get; set; }
        #endregion
    }
}