Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Bug 485625 - Allow overriding the conversion of a String into a Credential 

Signed-off-by: Julien Gouesse <gouessej@orange.fr>
This commit is contained in:
Julien Gouesse 2016-01-15 18:51:37 +01:00
parent 8dc6e25b89
commit 7ab6127e33
2 changed files with 100 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
jetty-util/src/main/java/org/eclipse/jetty/util/security/Credential.java
View File

@ -21,20 +21,21 @@ package org.eclipse.jetty.util.security;
import java.io.Serializable;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.util.ServiceLoader;
import org.eclipse.jetty.util.TypeUtil;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.util.security.Credential.Crypt;
import org.eclipse.jetty.util.security.Credential.MD5;
/* ------------------------------------------------------------ */
/**
* Credentials. The Credential class represents an abstract mechanism for
* checking authentication credentials. A credential instance either represents
* a secret, or some data that could only be derived from knowing the secret.
* Credentials. The Credential class represents an abstract mechanism for checking authentication credentials. A credential instance either represents a secret,
* or some data that could only be derived from knowing the secret.
* <p>
* Often a Credential is related to a Password via a one way algorithm, so while
* a Password itself is a Credential, a UnixCrypt or MD5 digest of a a password
* is only a credential that can be checked against the password.
* Often a Credential is related to a Password via a one way algorithm, so while a Password itself is a Credential, a UnixCrypt or MD5 digest of a a password is
* only a credential that can be checked against the password.
* <p>
* This class includes an implementation for unix Crypt an MD5 digest.
*
@ -43,6 +44,9 @@ import org.eclipse.jetty.util.log.Logger;
*/
public abstract class Credential implements Serializable
{
private static final ServiceLoader<CredentialProvider> CREDENTIAL_PROVIDER_LOADER = ServiceLoader.load(CredentialProvider.class);
private static final Logger LOG = Log.getLogger(Credential.class);
private static final long serialVersionUID = -7760551052768181572L;
@ -51,27 +55,41 @@ public abstract class Credential implements Serializable
/**
* Check a credential
*
* @param credentials The credential to check against. This may either be
* another Credential object, a Password object or a String
* which is interpreted by this credential.
* @return True if the credentials indicated that the shared secret is known
* to both this Credential and the passed credential.
* @param credentials
* The credential to check against. This may either be another Credential object, a Password object or a String which is interpreted by this
* credential.
* @return True if the credentials indicated that the shared secret is known to both this Credential and the passed credential.
*/
public abstract boolean check(Object credentials);
/* ------------------------------------------------------------ */
/**
* Get a credential from a String. If the credential String starts with a
* known Credential type (eg "CRYPT:" or "MD5:" ) then a Credential of that
* type is returned. Else the credential is assumed to be a Password.
* Get a credential from a String. If the credential String starts with a known Credential type (eg "CRYPT:" or "MD5:" ) then a Credential of that type is
* returned. Otherwise, it tries to find a credential provider whose prefix matches with the start of the credential String. Else the credential is assumed
* to be a Password.
*
* @param credential String representation of the credential
* @param credential
* String representation of the credential
* @return A Credential or Password instance.
*/
public static Credential getCredential(String credential)
{
if (credential.startsWith(Crypt.__TYPE)) return new Crypt(credential);
if (credential.startsWith(MD5.__TYPE)) return new MD5(credential);
if (credential.startsWith(Crypt.__TYPE))
return new Crypt(credential);
if (credential.startsWith(MD5.__TYPE))
return new MD5(credential);
for (CredentialProvider cp : CREDENTIAL_PROVIDER_LOADER)
{
if (credential.startsWith(cp.getPrefix()))
{
final Credential credentialObj = cp.getCredential(credential);
if (credentialObj != null)
{
return credentialObj;
}
}
}
return new Password(credential);
}
@ -90,37 +108,35 @@ public abstract class Credential implements Serializable
Crypt(String cooked)
{
_cooked = cooked.startsWith(Crypt.__TYPE) ? cooked.substring(__TYPE.length()) : cooked;
_cooked = cooked.startsWith(Crypt.__TYPE)?cooked.substring(__TYPE.length()):cooked;
}
@Override
public boolean check(Object credentials)
{
if (credentials instanceof char[])
credentials=new String((char[])credentials);
if (!(credentials instanceof String) && !(credentials instanceof Password))
credentials = new String((char[])credentials);
if (!(credentials instanceof String) && !(credentials instanceof Password))
LOG.warn("Can't check " + credentials.getClass() + " against CRYPT");
String passwd = credentials.toString();
return _cooked.equals(UnixCrypt.crypt(passwd, _cooked));
return _cooked.equals(UnixCrypt.crypt(passwd,_cooked));
}
@Override
public boolean equals (Object credential)
public boolean equals(Object credential)
{
if (!(credential instanceof Crypt))
return false;
Crypt c = (Crypt)credential;
return _cooked.equals(c._cooked);
}
public static String crypt(String user, String pw)
{
return "CRYPT:" + UnixCrypt.crypt(pw, user);
return "CRYPT:" + UnixCrypt.crypt(pw,user);
}
}
@ -143,8 +159,8 @@ public abstract class Credential implements Serializable
/* ------------------------------------------------------------ */
MD5(String digest)
{
digest = digest.startsWith(__TYPE) ? digest.substring(__TYPE.length()) : digest;
_digest = TypeUtil.parseBytes(digest, 16);
digest = digest.startsWith(__TYPE)?digest.substring(__TYPE.length()):digest;
_digest = TypeUtil.parseBytes(digest,16);
}
/* ------------------------------------------------------------ */
@ -162,17 +178,19 @@ public abstract class Credential implements Serializable
byte[] digest = null;
if (credentials instanceof char[])
credentials=new String((char[])credentials);
credentials = new String((char[])credentials);
if (credentials instanceof Password || credentials instanceof String)
{
synchronized (__md5Lock)
{
if (__md == null) __md = MessageDigest.getInstance("MD5");
if (__md == null)
__md = MessageDigest.getInstance("MD5");
__md.reset();
__md.update(credentials.toString().getBytes(StandardCharsets.ISO_8859_1));
digest = __md.digest();
}
if (digest == null || digest.length != _digest.length) return false;
if (digest == null || digest.length != _digest.length)
return false;
boolean digestMismatch = false;
for (int i = 0; i < digest.length; i++)
digestMismatch |= (digest[i] != _digest[i]);
@ -186,7 +204,7 @@ public abstract class Credential implements Serializable
{
// Allow credential to attempt check - i.e. this'll work
// for DigestAuthModule$Digest credentials
return ((Credential) credentials).check(this);
return ((Credential)credentials).check(this);
}
else
{
@ -200,22 +218,21 @@ public abstract class Credential implements Serializable
return false;
}
}
@Override
public boolean equals(Object obj)
{
if (obj instanceof MD5)
{
MD5 md5 = (MD5) obj;
if (_digest.length != md5._digest.length) return false;
MD5 md5 = (MD5)obj;
if (_digest.length != md5._digest.length)
return false;
boolean digestMismatch = false;
for (int i = 0; i < _digest.length; i++)
digestMismatch |= (_digest[i] != md5._digest[i]);
return !digestMismatch;
}
return false;
}
@ -245,7 +262,7 @@ public abstract class Credential implements Serializable
digest = __md.digest();
}
return __TYPE + TypeUtil.toString(digest, 16);
return __TYPE + TypeUtil.toString(digest,16);
}
catch (Exception e)
{

42
jetty-util/src/main/java/org/eclipse/jetty/util/security/CredentialProvider.java Normal file
View File

@ -0,0 +1,42 @@
//
// ========================================================================
// Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.util.security;
/**
* Provider of credentials, it converts a String into a credential if it starts with a given prefix
*
*/
public interface CredentialProvider
{
/**
* Get a credential from a String
*
* @param credential
* String representation of the credential
* @return A Credential or Password instance.
*/
Credential getCredential(String credential);
/**
* Get the prefix of the credential strings convertible into credentials
*
* @return prefix of the credential strings convertible into credentials
*/
String getPrefix();
}