Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2019-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2019-2024 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) 2019-2024 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;
import java.util.ArrayList;
import java.util.List;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class provides an implementation of the SCRAM-SHA-1 SASL mechanism as
* described in RFC 5802.
*/
@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
public final class SCRAMSHA1BindRequest
extends SCRAMBindRequest
{
/**
* The name for the SCRAM-SHA-1 SASL mechanism.
*/
@NotNull public static final String SCRAM_SHA_1_MECHANISM_NAME =
"SCRAM-SHA-1";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -1807244826649889525L;
/**
* Creates a new SCRAM-SHA-1 bind request with the provided information.
*
* @param username The username for this bind request. It must not be {@code
* null} or empty.
* @param password The password for this bind request. It must not be {@code
* null} or empty.
* @param controls The set of controls to include in the bind request. It may
* be {@code null} or empty if no controls are needed.
*/
public SCRAMSHA1BindRequest(@NotNull final String username,
@NotNull final String password,
@Nullable final Control... controls)
{
super(username, new ASN1OctetString(password), controls);
}
/**
* Creates a new SCRAM-SHA-1 bind request with the provided information.
*
* @param username The username for this bind request. It must not be {@code
* null} or empty.
* @param password The password for this bind request. It must not be {@code
* null} or empty.
* @param controls The set of controls to include in the bind request. It may
* be {@code null} or empty if no controls are needed.
*/
public SCRAMSHA1BindRequest(@NotNull final String username,
@NotNull final byte[] password,
@Nullable final Control... controls)
{
super(username, new ASN1OctetString(password), controls);
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getSASLMechanismName()
{
return SCRAM_SHA_1_MECHANISM_NAME;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
protected String getDigestAlgorithmName()
{
return "SHA-1";
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
protected String getMACAlgorithmName()
{
return "HmacSHA1";
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public SCRAMSHA1BindRequest getRebindRequest(@NotNull final String host,
final int port)
{
return duplicate();
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public SCRAMSHA1BindRequest duplicate()
{
return duplicate(getControls());
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public SCRAMSHA1BindRequest duplicate(@Nullable final Control[] controls)
{
final SCRAMSHA1BindRequest bindRequest = new SCRAMSHA1BindRequest(
getUsername(), getPasswordBytes(), controls);
bindRequest.setResponseTimeoutMillis(getResponseTimeoutMillis(null));
bindRequest.setIntermediateResponseListener(
getIntermediateResponseListener());
bindRequest.setReferralDepth(getReferralDepth());
bindRequest.setReferralConnector(getReferralConnectorInternal());
return bindRequest;
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("SCRAMSHA1BindRequest(username='");
buffer.append(getUsername());
buffer.append('\'');
final Control[] controls = getControls();
if (controls.length > 0)
{
buffer.append(", controls={");
for (int i=0; i < controls.length; i++)
{
if (i > 0)
{
buffer.append(", ");
}
buffer.append(controls[i]);
}
buffer.append('}');
}
buffer.append(')');
}
/**
* {@inheritDoc}
*/
@Override()
public void toCode(@NotNull final List lineList,
@NotNull final String requestID,
final int indentSpaces, final boolean includeProcessing)
{
// Create the request variable.
final List constructorArgs = new ArrayList<>(4);
constructorArgs.add(ToCodeArgHelper.createString(getUsername(),
"Username"));
constructorArgs.add(ToCodeArgHelper.createString("---redacted-password---",
"Password"));
final Control[] controls = getControls();
if (controls.length > 0)
{
constructorArgs.add(ToCodeArgHelper.createControlArray(controls,
"Bind Controls"));
}
ToCodeHelper.generateMethodCall(lineList, indentSpaces,
"SCRAMSHA1BindRequest", requestID + "Request",
"new SCRAMSHA1BindRequest", constructorArgs);
// Add lines for processing the request and obtaining the result.
if (includeProcessing)
{
// Generate a string with the appropriate indent.
final StringBuilder buffer = new StringBuilder();
for (int i=0; i < indentSpaces; i++)
{
buffer.append(' ');
}
final String indent = buffer.toString();
lineList.add("");
lineList.add(indent + "try");
lineList.add(indent + '{');
lineList.add(indent + " BindResult " + requestID +
"Result = connection.bind(" + requestID + "Request);");
lineList.add(indent + " // The bind was processed successfully.");
lineList.add(indent + '}');
lineList.add(indent + "catch (LDAPException e)");
lineList.add(indent + '{');
lineList.add(indent + " // The bind failed. Maybe the following will " +
"help explain why.");
lineList.add(indent + " // Note that the connection is now likely in " +
"an unauthenticated state.");
lineList.add(indent + " ResultCode resultCode = e.getResultCode();");
lineList.add(indent + " String message = e.getMessage();");
lineList.add(indent + " String matchedDN = e.getMatchedDN();");
lineList.add(indent + " String[] referralURLs = e.getReferralURLs();");
lineList.add(indent + " Control[] responseControls = " +
"e.getResponseControls();");
lineList.add(indent + '}');
}
}
}
