Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JENKINS-55813] Improve analysis of the AD attributes #34

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/main/java/hudson/security/LDAPSecurityRealm.java
Original file line number Diff line number Diff line change
Expand Up @@ -1337,6 +1337,20 @@ public LdapUserDetails loadUserByUsername(String username) throws UsernameNotFou
user.addAuthority(extraAuthority);
}
}

if (!UserAttributesHelper.checkIfAccountNonExpired(v)) {
user.setAccountNonExpired(false);
}
if (!UserAttributesHelper.checkIfAccountNonLocked(v)) {
user.setAccountNonLocked(false);
}
if (!UserAttributesHelper.checkIfCredentialsAreNonExpired(v)) {
user.setCredentialsNonExpired(false);
}
if (!UserAttributesHelper.checkIfUserIsEnabled(v)) {
user.setEnabled(false);
}

if (StringUtils.isNotEmpty(configurationId)) {
ldapUser = new DelegatedLdapUserDetails(user.createUserDetails(), configurationId);
} else {
Expand Down
190 changes: 190 additions & 0 deletions src/main/java/hudson/security/UserAttributesHelper.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
/*
* 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 String ATTR_USER_ACCOUNT_CONTROL = "userAccountControl";
private static String ATTR_ACCOUNT_EXPIRES = "accountExpires";
// for Windows Server 2003-based domain
private static String ATTR_USER_ACCOUNT_CONTROL_COMPUTED = "msDS-User-Account-Control-Computed";
// for ADAM (Active Directory Application Mode), replace the ADS_UF_DISABLED
private static String ATTR_USER_ACCOUNT_DISABLED = "msDS-UserAccountDisabled";
// for ADAM, replace the ADS_UF_PASSWORD_EXPIRED
private static 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 long ACCOUNT_NO_EXPIRATION = 0x7FFFFFFFFFFFFFFFL;
private static int ADS_UF_DISABLED = 0x0002;
private static int ADS_UF_LOCK_OUT = 0x0010;
private static int ADS_UF_PASSWORD_EXPIRED = 0x800000;

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 = getNowIn100NsFromJan1601();
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 getNowIn100NsFromJan1601() {
GregorianCalendar win32Epoch = new GregorianCalendar(1601, Calendar.JANUARY, 1);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ZonedDateTime.of(1601, 1, 1, 0, 0, 0, 0, ZoneOffset.UTC) could be easier to calculate with here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I followed the code as mentioned in the javadoc
  2. I do not find the proposed one to be more readable than the one in the PR

If anybody else agree on your proposal I will change ;)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My proposal was taking a random java.time class that sounded appropriate. Calendar is much more annoying to use.

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();
}
}