com.unboundid.ldap.sdk.unboundidds.controls.GetEffectiveRightsRequestControl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2008-2022 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2022 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2008-2022 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.controls;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.JSONControlDecodeHelper;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;
import com.unboundid.util.json.JSONArray;
import com.unboundid.util.json.JSONField;
import com.unboundid.util.json.JSONObject;
import com.unboundid.util.json.JSONString;
import com.unboundid.util.json.JSONValue;
import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
/**
* This class provides an implementation of the get effective rights request
* control, which may be included in a search request to indicate that matching
* entries should include information about the rights a given user may have
* when interacting with that entry.
*
*
* NOTE: This class, and other classes within the
* {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
* supported for use against Ping Identity, UnboundID, and
* Nokia/Alcatel-Lucent 8661 server products. These classes provide support
* for proprietary functionality or for external specifications that are not
* considered stable or mature enough to be guaranteed to work in an
* interoperable way with other types of LDAP servers.
*
*
* When the get effective rights control is included in a search request, then
* each entry returned may include information about the rights that the
* specified user has for that entry in the {@code aclRights} operational
* attribute. Note that because this is an operational attribute, it must be
* explicitly included in the set of attributes to return.
*
* If the {@code aclRights} attribute is included in the entry, then it will be
* present with multiple sets of options. In one case, it will have an option
* of "entryLevel", which provides information about the rights that the user
* has for the entry in general (see the {@link EntryRight} enum for a list of
* the entry-level rights that can be held). In all other cases, it will have
* one option of "attributeLevel" and another option that is the name of the
* attribute for which the set of rights is granted (see the
* {@link AttributeRight} enum for a list of the attribute-level rights that can
* be held). In either case, the value will be a comma-delimited list of
* right strings, where each right string is the name of the right followed by
* a colon and a one to indicate that the right is granted or zero to indicate
* that it is not granted. The {@link EffectiveRightsEntry} class provides a
* simple means of accessing the information encoded in the values of the
* {@code aclRights} attribute.
*
* This control was designed by Sun Microsystems, and it is not the same as the
* get effective rights control referenced in the draft-ietf-ldapext-acl-model
* Internet draft. The value for this control should be encoded as follows:
*
*
* GET_EFFECTIVE_RIGHTS := SEQUENCE {
* authzID authzID,
* attributes SEQUENCE OF AttributeType OPTIONAL }
*
* Example
* The following example demonstrates the use of the get effective rights
* control to determine whether user "uid=admin,dc=example,dc=com" has the
* ability to change the password for the user with uid "john.doe":
*
* SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
* SearchScope.SUB, Filter.createEqualityFilter("uid", "john.doe"),
* "userPassword", "aclRights");
* searchRequest.addControl(new GetEffectiveRightsRequestControl(
* "dn:uid=admin,dc=example,dc=com"));
* SearchResult searchResult = connection.search(searchRequest);
*
* for (SearchResultEntry entry : searchResult.getSearchEntries())
* {
* EffectiveRightsEntry effectiveRightsEntry =
* new EffectiveRightsEntry(entry);
* if (effectiveRightsEntry.rightsInformationAvailable())
* {
* if (effectiveRightsEntry.hasAttributeRight(AttributeRight.WRITE,
* "userPassword"))
* {
* // The admin user has permission to change the target user's password.
* }
* else
* {
* // The admin user does not have permission to change the target user's
* // password.
* }
* }
* else
* {
* // No effective rights information was returned.
* }
* }
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class GetEffectiveRightsRequestControl
extends Control
{
/**
* The OID (1.3.6.1.4.1.42.2.27.9.5.2) for the get effective rights request
* control.
*/
@NotNull public static final String GET_EFFECTIVE_RIGHTS_REQUEST_OID =
"1.3.6.1.4.1.42.2.27.9.5.2";
/**
* The name of the field used to specify the set of target attributes in the
* JSON representation of this control.
*/
@NotNull private static final String JSON_FIELD_ATTRIBUTES = "attributes";
/**
* The name of the field used to specify the authorization ID in the JSON
* representation of this control.
*/
@NotNull private static final String JSON_FIELD_AUTHORIZATION_ID =
"authorization-id";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 354733122036206073L;
// The authorization ID of the user for which to calculate the effective
// rights.
@NotNull private final String authzID;
// The names of the attribute types for which to calculate the effective
// rights.
@NotNull private final String[] attributes;
/**
* Creates a new get effective rights request control with the provided
* information. It will not be marked critical.
*
* @param authzID The authorization ID of the user for whom the effective
* rights should be calculated. It must not be
* {@code null}.
* @param attributes The set of attributes for which to calculate the
* effective rights.
*/
public GetEffectiveRightsRequestControl(@NotNull final String authzID,
@NotNull final String... attributes)
{
this(false, authzID, attributes);
}
/**
* Creates a new get effective rights request control with the provided
* information. It will not be marked critical.
*
* @param isCritical Indicates whether this control should be marked
* critical.
* @param authzID The authorization ID of the user for whom the effective
* rights should be calculated. It must not be
* {@code null}.
* @param attributes The set of attributes for which to calculate the
* effective rights.
*/
public GetEffectiveRightsRequestControl(final boolean isCritical,
@NotNull final String authzID,
@NotNull final String... attributes)
{
super(GET_EFFECTIVE_RIGHTS_REQUEST_OID, isCritical,
encodeValue(authzID, attributes));
this.authzID = authzID;
this.attributes = attributes;
}
/**
* Creates a new get effective rights request control which is decoded from
* the provided generic control.
*
* @param control The generic control to be decoded as a get effective
* rights request control.
*
* @throws LDAPException If the provided control cannot be decoded as a get
* effective rights request control.
*/
public GetEffectiveRightsRequestControl(@NotNull final Control control)
throws LDAPException
{
super(control);
final ASN1OctetString value = control.getValue();
if (value == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GER_REQUEST_NO_VALUE.get());
}
final ASN1Element[] elements;
try
{
final ASN1Element valueElement = ASN1Element.decode(value.getValue());
elements = ASN1Sequence.decodeAsSequence(valueElement).elements();
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GER_REQUEST_VALUE_NOT_SEQUENCE.get(e), e);
}
if ((elements.length < 1) || (elements.length > 2))
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GER_REQUEST_INVALID_ELEMENT_COUNT.get(
elements.length));
}
authzID = ASN1OctetString.decodeAsOctetString(elements[0]).stringValue();
if (elements.length == 2)
{
try
{
final ASN1Element[] attrElements =
ASN1Sequence.decodeAsSequence(elements[1]).elements();
attributes = new String[attrElements.length];
for (int i=0; i < attrElements.length; i++)
{
attributes[i] = ASN1OctetString.decodeAsOctetString(
attrElements[i]).stringValue();
}
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GER_REQUEST_CANNOT_DECODE.get(e), e);
}
}
else
{
attributes = StaticUtils.NO_STRINGS;
}
}
/**
* Encodes the provided information into an ASN.1 octet string suitable for
* use as the value of this control.
*
* @param authzID The authorization ID of the user for whom the effective
* rights should be calculated. It must not be
* {@code null}.
* @param attributes The set of attributes for which to calculate the
* effective rights.
*
* @return An ASN.1 octet string containing the encoded control value.
*/
@NotNull()
private static ASN1OctetString encodeValue(@NotNull final String authzID,
@Nullable final String[] attributes)
{
Validator.ensureNotNull(authzID);
final ASN1Element[] elements;
if ((attributes == null) || (attributes.length == 0))
{
elements = new ASN1Element[]
{
new ASN1OctetString(authzID),
new ASN1Sequence()
};
}
else
{
final ASN1Element[] attrElements = new ASN1Element[attributes.length];
for (int i=0; i < attributes.length; i++)
{
attrElements[i] = new ASN1OctetString(attributes[i]);
}
elements = new ASN1Element[]
{
new ASN1OctetString(authzID),
new ASN1Sequence(attrElements)
};
}
return new ASN1OctetString(new ASN1Sequence(elements).encode());
}
/**
* Retrieves the authorization ID of the user for whom to calculate the
* effective rights.
*
* @return The authorization ID of the user for whom to calculate the
* effective rights.
*/
@NotNull()
public String getAuthzID()
{
return authzID;
}
/**
* Retrieves the names of the attributes for which to calculate the effective
* rights information.
*
* @return The names of the attributes for which to calculate the effective
* rights information, or an empty array if no attribute names were
* specified.
*/
@NotNull()
public String[] getAttributes()
{
return attributes;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getControlName()
{
return INFO_CONTROL_NAME_GET_EFFECTIVE_RIGHTS_REQUEST.get();
}
/**
* Retrieves a representation of this get effective rights request control as
* a JSON object. The JSON object uses the following fields:
*
* -
* {@code oid} -- A mandatory string field whose value is the object
* identifier for this control. For the get effective rights request
* control, the OID is "1.3.6.1.4.1.42.2.27.9.5.2".
*
* -
* {@code control-name} -- An optional string field whose value is a
* human-readable name for this control. This field is only intended for
* descriptive purposes, and when decoding a control, the {@code oid}
* field should be used to identify the type of control.
*
* -
* {@code criticality} -- A mandatory Boolean field used to indicate
* whether this control is considered critical.
*
* -
* {@code value-base64} -- An optional string field whose value is a
* base64-encoded representation of the raw value for this get effective
* rights request control. Exactly one of the {@code value-base64} and
* {@code value-json} fields must be present.
*
* -
* {@code value-json} -- An optional JSON object field whose value is a
* user-friendly representation of the value for this get effective rights
* request control. Exactly one of the {@code value-base64} and
* {@code value-json} fields must be present, and if the
* {@code value-json} field is used, then it will use the following
* fields:
*
* -
* {@code authorization-id} -- A mandatory string field whose value is
* the authorization identity of the user for whom to retrieve the
* effective rights.
*
* -
* {@code attributes} -- An optional array field whose values are
* strings that represent the names of the attributes for which to
* make the effective rights determination.
*
*
*
*
*
* @return A JSON object that contains a representation of this control.
*/
@Override()
@NotNull()
public JSONObject toJSONControl()
{
final Map valueFields = new LinkedHashMap<>();
valueFields.put(JSON_FIELD_AUTHORIZATION_ID, new JSONString(authzID));
if (attributes.length > 0)
{
final List attributeValues = new ArrayList<>();
for (final String attribute : attributes)
{
attributeValues.add(new JSONString(attribute));
}
valueFields.put(JSON_FIELD_ATTRIBUTES, new JSONArray(attributeValues));
}
return new JSONObject(
new JSONField(JSONControlDecodeHelper.JSON_FIELD_OID,
GET_EFFECTIVE_RIGHTS_REQUEST_OID),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CONTROL_NAME,
INFO_CONTROL_NAME_GET_EFFECTIVE_RIGHTS_REQUEST.get()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CRITICALITY,
isCritical()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_VALUE_JSON,
new JSONObject(valueFields)));
}
/**
* Attempts to decode the provided object as a JSON representation of a get
* effective rights request control.
*
* @param controlObject The JSON object to be decoded. It must not be
* {@code null}.
* @param strict Indicates whether to use strict mode when decoding
* the provided JSON object. If this is {@code true},
* then this method will throw an exception if the
* provided JSON object contains any unrecognized
* fields. If this is {@code false}, then unrecognized
* fields will be ignored.
*
* @return The get effective rights request control that was decoded from
* the provided JSON object.
*
* @throws LDAPException If the provided JSON object cannot be parsed as a
* valid get effective rights request control.
*/
@NotNull()
public static GetEffectiveRightsRequestControl decodeJSONControl(
@NotNull final JSONObject controlObject,
final boolean strict)
throws LDAPException
{
final JSONControlDecodeHelper jsonControl = new JSONControlDecodeHelper(
controlObject, strict, true, true);
final ASN1OctetString rawValue = jsonControl.getRawValue();
if (rawValue != null)
{
return new GetEffectiveRightsRequestControl(new Control(
jsonControl.getOID(), jsonControl.getCriticality(), rawValue));
}
final JSONObject valueObject = jsonControl.getValueObject();
final String authorizationID =
valueObject.getFieldAsString(JSON_FIELD_AUTHORIZATION_ID);
if (authorizationID == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GER_REQUEST_JSON_MISSING_AUTHZ_ID.get(
controlObject.toSingleLineString(),
JSON_FIELD_AUTHORIZATION_ID));
}
final String[] attributes;
final List attrValues =
valueObject.getFieldAsArray(JSON_FIELD_ATTRIBUTES);
if (attrValues == null)
{
attributes = StaticUtils.NO_STRINGS;
}
else
{
attributes = new String[attrValues.size()];
for (int i=0; i < attributes.length; i++)
{
final JSONValue v = attrValues.get(i);
if (v instanceof JSONString)
{
attributes[i] = ((JSONString) v).stringValue();
}
else
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GER_REQUEST_JSON_ATTR_NOT_STRING.get(
controlObject.toSingleLineString(),
JSON_FIELD_ATTRIBUTES));
}
}
}
if (strict)
{
final List unrecognizedFields =
JSONControlDecodeHelper.getControlObjectUnexpectedFields(
valueObject, JSON_FIELD_AUTHORIZATION_ID,
JSON_FIELD_ATTRIBUTES);
if (! unrecognizedFields.isEmpty())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GER_REQUEST_JSON_CONTROL_UNRECOGNIZED_FIELD.get(
controlObject.toSingleLineString(),
unrecognizedFields.get(0)));
}
}
return new GetEffectiveRightsRequestControl(jsonControl.getCriticality(),
authorizationID, attributes);
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("GetEffectiveRightsRequestControl(authzId='");
buffer.append(authzID);
buffer.append('\'');
if (attributes.length > 0)
{
buffer.append(", attributes={");
for (int i=0; i < attributes.length; i++)
{
if (i > 0)
{
buffer.append(", ");
}
buffer.append(attributes[i]);
}
buffer.append('}');
}
buffer.append(", isCritical=");
buffer.append(isCritical());
buffer.append(')');
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy