| /* |
| * Copyright (c) 2002, 2018 Oracle and/or its affiliates. All rights reserved. |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v. 2.0, which is available at |
| * http://www.eclipse.org/legal/epl-2.0. |
| * |
| * This Source Code may also be made available under the following Secondary |
| * Licenses when the conditions for such availability set forth in the |
| * Eclipse Public License v. 2.0 are satisfied: GNU General Public License, |
| * version 2 with the GNU Classpath Exception, which is available at |
| * https://www.gnu.org/software/classpath/license.html. |
| * |
| * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 |
| */ |
| |
| package com.sun.jndi.ldap.ctl; |
| |
| import javax.naming.ldap.BasicControl; |
| import java.io.IOException; |
| |
| /** |
| * This class implements the LDAP response control notifying |
| * password expiration. The Password Expiring control is a notification |
| * to the client when password is about to expiring according to the |
| * server's password policy. |
| * This control should be checked whenever a LDAP bind operation is |
| * performed as a result of operations on the context such as when a new |
| * initial context is created or when {@link javax.naming.ldap.InitialLdapContext#reconnect(javax.naming.ldap.Control[]) InitialLdapContext.reconnect} |
| * is called. |
| * <p> |
| * The Password Expiring control is defined in <tt>draft-vchu-ldap-pwd-policy-00.txt</tt> |
| * <p> |
| * The object identifier for Password Expiry is 2.16.840.1.113730.3.4.5 and |
| * the value returned indicates the time left until the password expires. |
| * The control's value has the following ASN.1 definition: |
| * <pre> |
| * |
| * PasswordExpiring ::= OCTET STRING ; time in seconds until the |
| * ; password expires |
| * |
| * </pre> |
| * <p> |
| * The following code sample shows how the control may be used: |
| * <pre> |
| * |
| * // create an initial context using the supplied environment properties |
| * LdapContext ctx = new InitialLdapContext(env, null); |
| * Control[] respControls; |
| * |
| * // retrieve response controls |
| * if ((respControls = ctx.getResponseControls()) != null) { |
| * for (int i = 0; i < respControls.length; i++) { |
| * |
| * // locate the password expiring control |
| * if (respControls[i] instanceof PasswordExpiringResponseControl) { |
| * System.out.println("Password expires in " + |
| * ((PasswordExpiringResponseControl) respControls[i]) |
| * .timeRemaining() + " seconds"); |
| * } |
| * } |
| * } |
| * |
| * </pre> |
| * |
| * @see PasswordExpiredResponseControl |
| * @author Vincent Ryan |
| */ |
| public class PasswordExpiringResponseControl extends BasicControl { |
| |
| /** |
| * The password expiring control's assigned object identifier is |
| * 2.16.840.1.113730.3.4.5. |
| */ |
| public static final String OID = "2.16.840.1.113730.3.4.5"; |
| |
| /** |
| * The time remaining until the password expires |
| * @serial |
| */ |
| private long timeLeft; |
| |
| private static final long serialVersionUID = -7968094990572151704L; |
| |
| /** |
| * Constructs a control to notify of password expiration. |
| * |
| * @param id The control's object identifier string. |
| * @param criticality The control's criticality. |
| * @param value The control's ASN.1 BER encoded value. |
| * May be null. |
| * @exception IOException if an error is encountered |
| * while decoding the control's value. |
| */ |
| PasswordExpiringResponseControl(String id, boolean criticality, byte[] value) throws IOException { |
| super(id, criticality, value); |
| if ((value != null) && (value.length > 0)) { |
| timeLeft = Long.parseLong(new String(value)); |
| } |
| } |
| |
| /** |
| * The time remaining until the password expires. |
| * |
| * @return The number of seconds until the password expires. |
| */ |
| public long timeRemaining() { |
| return timeLeft; |
| } |
| |
| /** |
| * Retrieves the PasswordExpiring control response's ASN.1 BER |
| * encoded value. |
| * |
| * @return The ASN.1 BER encoded value of the LDAP control. |
| */ |
| @Override |
| public byte[] getEncodedValue() { |
| if (value == null) { |
| return null; |
| } |
| // return a copy of value |
| byte[] retval = new byte[value.length]; |
| System.arraycopy(value, 0, retval, 0, value.length); |
| return retval; |
| } |
| } |