org.wildfly.security.mechanism.scram.ScramUtil Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source.
* Copyright 2015 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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.
*/
package org.wildfly.security.mechanism.scram;
import static org.wildfly.security.mechanism._private.ElytronMessages.log;
import java.nio.charset.StandardCharsets;
import java.util.Random;
import org.wildfly.common.iteration.ByteIterator;
/**
* Common utility functions used by SCRAM authentication mechanism.
*
* @author David M. Lloyd
*/
class ScramUtil {
private static final byte[] randomCharDictionary;
static final byte[] CLIENT_KEY_BYTES = "Client Key".getBytes(StandardCharsets.UTF_8);
static final byte[] SERVER_KEY_BYTES = "Server Key".getBytes(StandardCharsets.UTF_8);
static {
byte[] dict = new byte[93];
int i = 0;
for (byte c = '!'; c < ','; c ++) {
dict[i ++] = c;
}
for (byte c = ',' + 1; c < 127; c ++) {
dict[i ++] = c;
}
assert i == dict.length;
randomCharDictionary = dict;
}
/**
* Generates nonce of specified length.
*
* @param length the length of the nonce.
* @param random the RNG used for creating the nonce.
* @return a byte array containing the nonce.
*/
public static byte[] generateNonce(int length, Random random) {
final byte[] chars = new byte[length];
for (int i = 0; i < length; i ++) {
chars[i] = randomCharDictionary[random.nextInt(93)];
}
return chars;
}
/**
* Parses positive integer from provided ByteIterator.
*
* @param i the ByteIterator to parse the positive integer from.
* @return the parsed integer.
* @throws NumberFormatException if the ByteIterator doesn't contain number or the number is too big for an integer
*/
public static int parsePosInt(final ByteIterator i) {
int a, c;
if (! i.hasNext()) {
throw log.emptyNumber();
}
c = i.next();
if (c >= '1' && c <= '9') {
a = c - '0';
} else {
throw log.invalidNumericCharacter();
}
while (i.hasNext()) {
c = i.next();
if (c >= '0' && c <= '9') {
a = (a << 3) + (a << 1) + (c - '0');
if (a < 0) {
throw log.tooBigNumber();
}
} else {
throw log.invalidNumericCharacter();
}
}
return a;
}
/**
* Bitwise XOR operation between two byte arrays of the same length.
* XOR operation returns 1 if only one of two corresponding bits is 1. For example: 0101 and 0011 gives 0110.
*
* @param hash the first byte array for the XOR operation. This byte array is modified by the method in place
* @param input the second byte array for the XOR operation.
*/
static void xor(final byte[] hash, final byte[] input) {
assert hash.length == input.length;
for (int i = 0; i < hash.length; i++) {
hash[i] ^= input[i];
}
}
}