UserAttributesHelper.java

/*
 * The MIT License
 *
 * Copyright (c) 2019, CloudBees, Inc.
 *
 * 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.
 */
package hudson.security;

import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.naming.NamingException;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.concurrent.TimeUnit;

/**
 * Ease all the computations required to determine the user account optional attributes for creating
 * the UserDetails that will be used by the SecurityRealm
 */
@Restricted(NoExternalUse.class)
public class UserAttributesHelper {
    // https://support.microsoft.com/en-us/help/305144/how-to-use-the-useraccountcontrol-flags-to-manipulate-user-account-pro
    private static final String ATTR_USER_ACCOUNT_CONTROL = "userAccountControl";
    private static final String ATTR_ACCOUNT_EXPIRES = "accountExpires";
    // for Windows Server 2003-based domain
    private static final String ATTR_USER_ACCOUNT_CONTROL_COMPUTED = "msDS-User-Account-Control-Computed";
    // for ADAM (Active Directory Application Mode), replace the ADS_UF_DISABLED
    private static final String ATTR_USER_ACCOUNT_DISABLED = "msDS-UserAccountDisabled";
    // for ADAM, replace the ADS_UF_PASSWORD_EXPIRED
    private static final String ATTR_USER_PASSWORD_EXPIRED = "msDS-UserPasswordExpired";

    // https://docs.microsoft.com/en-us/windows/desktop/adschema/a-accountexpires
    // constant names follow the code in Iads.h
    private static final long ACCOUNT_NO_EXPIRATION = 0x7FFF_FFFF_FFFF_FFFFL;
    private static final int ADS_UF_DISABLED = 0x0002;
    private static final int ADS_UF_LOCK_OUT = 0x0010;
    private static final int ADS_UF_PASSWORD_EXPIRED = 0x80_0000;

    public static boolean checkIfUserIsEnabled(@Nonnull Attributes user) {
        try {
            String userAccountControl = getStringAttribute(user, ATTR_USER_ACCOUNT_CONTROL);
            if (userAccountControl != null) {
                int uacAsInt = Integer.parseInt(userAccountControl);
                if ((uacAsInt & ADS_UF_DISABLED) == ADS_UF_DISABLED) {
                    return false;
                }
            }

            String adamUserAccountDisabled = getStringAttribute(user, ATTR_USER_ACCOUNT_DISABLED);
            if (adamUserAccountDisabled != null) {
                if (adamUserAccountDisabled.equals("true")) {
                    return false;
                } else {
                    return true;
                }
            }

            return true;
        } catch (NamingException e) {
            return true;
        }
    }

    public static boolean checkIfAccountNonExpired(@Nonnull Attributes user) {
        try {
            String accountExpirationDate = getStringAttribute(user, ATTR_ACCOUNT_EXPIRES);
            if (accountExpirationDate != null) {
                long expirationAsLong = Long.parseLong(accountExpirationDate);
                if (expirationAsLong == 0L || expirationAsLong == ACCOUNT_NO_EXPIRATION) {
                    return true;
                }

                long nowIn100NsFromJan1601 = getWin32EpochHundredNanos();
                boolean expired = expirationAsLong < nowIn100NsFromJan1601;
                return !expired;
            }

            return true;
        } catch (NamingException e) {
            return true;
        }
    }

    // documentation: https://docs.microsoft.com/en-us/windows/desktop/adschema/a-accountexpires
    // code inspired by https://community.oracle.com/thread/1157460
    private static long getWin32EpochHundredNanos() {
        GregorianCalendar win32Epoch = new GregorianCalendar(1601, Calendar.JANUARY, 1);
        Date win32EpochDate = win32Epoch.getTime();
        // note that 1/1/1601 will be returned as a negative value by Java
        GregorianCalendar today = new GregorianCalendar();
        Date todayDate = today.getTime();
        long timeSinceWin32EpochInMs = todayDate.getTime() - win32EpochDate.getTime();
        // milliseconds to microseconds => x1000
        long timeSinceWin32EpochInNs = TimeUnit.NANOSECONDS.convert(timeSinceWin32EpochInMs, TimeUnit.MILLISECONDS);
        // but we need in 100 ns, as 1000 ns = 1 micro, add a x10 factor
        return timeSinceWin32EpochInNs * 100;
    }

    public static boolean checkIfCredentialsAreNonExpired(@Nonnull Attributes user) {
        try {
            String userAccountControl = getStringAttribute(user, ATTR_USER_ACCOUNT_CONTROL);
            if (userAccountControl != null) {
                int uacAsInt = Integer.parseInt(userAccountControl);
                if ((uacAsInt & ADS_UF_PASSWORD_EXPIRED) == ADS_UF_PASSWORD_EXPIRED) {
                    return false;
                }
            }

            String userAccountControlComputed = getStringAttribute(user, ATTR_USER_ACCOUNT_CONTROL_COMPUTED);
            if (userAccountControlComputed != null) {
                int uacAsInt = Integer.parseInt(userAccountControlComputed);
                if ((uacAsInt & ADS_UF_PASSWORD_EXPIRED) == ADS_UF_PASSWORD_EXPIRED) {
                    return false;
                }
            }

            String adamUserPasswordExpired = getStringAttribute(user, ATTR_USER_PASSWORD_EXPIRED);
            if (adamUserPasswordExpired != null) {
                if (adamUserPasswordExpired.equals("true")) {
                    return false;
                } else {
                    return true;
                }
            }

            return true;
        } catch (NamingException e) {
            return true;
        }
    }

    public static boolean checkIfAccountNonLocked(@Nonnull Attributes user) {
        try {
            String userAccountControl = getStringAttribute(user, ATTR_USER_ACCOUNT_CONTROL);
            if (userAccountControl != null) {
                int uacAsInt = Integer.parseInt(userAccountControl);
                if ((uacAsInt & ADS_UF_LOCK_OUT) == ADS_UF_LOCK_OUT) {
                    return false;
                }
            }

            String userAccountControlComputed = getStringAttribute(user, ATTR_USER_ACCOUNT_CONTROL_COMPUTED);
            if (userAccountControlComputed != null) {
                int uacAsInt = Integer.parseInt(userAccountControlComputed);
                if ((uacAsInt & ADS_UF_LOCK_OUT) == ADS_UF_LOCK_OUT) {
                    return false;
                }
            }

            return true;
        } catch (NamingException e) {
            return true;
        }
    }

    private static @CheckForNull String getStringAttribute(@Nonnull Attributes user, @Nonnull String name) throws NamingException {
        Attribute a = user.get(name);
        if (a == null) {
            return null;
        }
        Object v = a.get();
        if (v == null) {
            return null;
        }
        return v.toString();
    }
}