Return-Path: X-Original-To: apmail-directory-commits-archive@www.apache.org Delivered-To: apmail-directory-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id A84F318CEF for ; Thu, 30 Jul 2015 06:24:11 +0000 (UTC) Received: (qmail 77213 invoked by uid 500); 30 Jul 2015 06:24:09 -0000 Delivered-To: apmail-directory-commits-archive@directory.apache.org Received: (qmail 77025 invoked by uid 500); 30 Jul 2015 06:24:09 -0000 Mailing-List: contact commits-help@directory.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@directory.apache.org Delivered-To: mailing list commits@directory.apache.org Received: (qmail 76086 invoked by uid 99); 30 Jul 2015 06:24:09 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 30 Jul 2015 06:24:09 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 17CF6E683E; Thu, 30 Jul 2015 06:24:09 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: plusplusjiajia@apache.org To: commits@directory.apache.org Date: Thu, 30 Jul 2015 06:24:34 -0000 Message-Id: In-Reply-To: <4712c8cab9e241bbad3c702a6ba0637e@git.apache.org> References: <4712c8cab9e241bbad3c702a6ba0637e@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [27/50] [abbrv] directory-kerby git commit: DIRKRB-382 Promote kerby-config and kerby-util as top level modules, getting rid of lib http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/Base64.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/Base64.java b/kerby-util/src/main/java/org/apache/kerby/util/Base64.java new file mode 100644 index 0000000..143c8cc --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/Base64.java @@ -0,0 +1,1048 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.kerby.util; + +import java.math.BigInteger; + +/** + * Provides Base64 encoding and decoding as defined by RFC 2045. + * + *

+ * This class implements section 6.8. Base64 Content-Transfer-Encoding from RFC 2045 Multipurpose + * Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies by Freed and Borenstein. + *

+ *

+ * The class can be parameterized in the following manner with various constructors: + *

    + *
  • URL-safe mode: Default off.
  • + *
  • Line length: Default 76. Line length that aren't multiples of 4 will still essentially end up being multiples of + * 4 in the encoded data. + *
  • Line separator: Default is CRLF ("\r\n")
  • + *
+ *

+ *

+ * Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode + * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc). + *

+ * + * @see RFC 2045 + * @author Apache Software Foundation + * @since 1.0 + * @version $Id: Base64.java 155 2009-09-17 21:00:58Z julius $ + */ +public class Base64 { + private static final int DEFAULT_BUFFER_RESIZE_FACTOR = 2; + + private static final int DEFAULT_BUFFER_SIZE = 8192; + + /** + * Chunk size per RFC 2045 section 6.8. + * + *

+ * The {@value} character limit does not count the trailing CRLF, but counts all other characters, including any + * equal signs. + *

+ * + * @see RFC 2045 section 6.8 + */ + static final int CHUNK_SIZE = 76; + + /** + * Chunk separator per RFC 2045 section 2.1. + * + *

+ * N.B. The next major release may break compatibility and make this field private. + *

+ * + * @see RFC 2045 section 2.1 + */ + static final byte[] CHUNK_SEPARATOR = {'\r', '\n'}; + + /** + * This array is a lookup table that translates 6-bit positive integer index values into their "Base64 Alphabet" + * equivalents as specified in Table 1 of RFC 2045. + * + * Thanks to "commons" project in ws.apache.org for this code. + * http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/ + */ + private static final byte[] STANDARD_ENCODE_TABLE = { + 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', + 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', + 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', + 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', + '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/' + }; + + /** + * This is a copy of the STANDARD_ENCODE_TABLE above, but with + and / + * changed to - and _ to make the encoded Base64 results more URL-SAFE. + * This table is only used when the Base64's mode is set to URL-SAFE. + */ + private static final byte[] URL_SAFE_ENCODE_TABLE = { + 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', + 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', + 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', + 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', + '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-', '_' + }; + + /** + * Byte used to pad output. + */ + private static final byte PAD = '='; + + /** + * This array is a lookup table that translates Unicode characters drawn from the "Base64 Alphabet" (as specified in + * Table 1 of RFC 2045) into their 6-bit positive integer equivalents. Characters that are not in the Base64 + * alphabet but fall within the bounds of the array are translated to -1. + * + * Note: '+' and '-' both decode to 62. '/' and '_' both decode to 63. This means decoder seamlessly handles both + * URL_SAFE and STANDARD base64. (The encoder, on the other hand, needs to know ahead of time what to emit). + * + * Thanks to "commons" project in ws.apache.org for this code. + * http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/ + */ + private static final byte[] DECODE_TABLE = { + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, + -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, 62, -1, 63, 52, 53, 54, + 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -1, -1, -1, -1, 0, 1, 2, 3, 4, + 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, + 24, 25, -1, -1, -1, -1, 63, -1, 26, 27, 28, 29, 30, 31, 32, 33, 34, + 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51 + }; + + /** Mask used to extract 6 bits, used when encoding */ + private static final int MASK_6BITS = 0x3f; + + /** Mask used to extract 8 bits, used in decoding base64 bytes */ + private static final int MASK_8BITS = 0xff; + + // The static final fields above are used for the original static byte[] methods on Base64. + // The private member fields below are used with the new streaming approach, which requires + // some state be preserved between calls of encode() and decode(). + + /** + * Encode table to use: either STANDARD or URL_SAFE. Note: the DECODE_TABLE above remains static because it is able + * to decode both STANDARD and URL_SAFE streams, but the encodeTable must be a member variable so we can switch + * between the two modes. + */ + private final byte[] encodeTable; + + /** + * Line length for encoding. Not used when decoding. A value of zero or less implies no chunking of the base64 + * encoded data. + */ + private final int lineLength; + + /** + * Line separator for encoding. Not used when decoding. Only used if lineLength > 0. + */ + private final byte[] lineSeparator; + + /** + * Convenience variable to help us determine when our buffer is going to run out of room and needs resizing. + * decodeSize = 3 + lineSeparator.length; + */ + private final int decodeSize; + + /** + * Convenience variable to help us determine when our buffer is going to run out of room and needs resizing. + * encodeSize = 4 + lineSeparator.length; + */ + private final int encodeSize; + + /** + * Buffer for streaming. + */ + private byte[] buffer; + + /** + * Position where next character should be written in the buffer. + */ + private int pos; + + /** + * Position where next character should be read from the buffer. + */ + private int readPos; + + /** + * Variable tracks how many characters have been written to the current line. Only used when encoding. We use it to + * make sure each encoded line never goes beyond lineLength (if lineLength > 0). + */ + private int currentLinePos; + + /** + * Writes to the buffer only occur after every 3 reads when encoding, an every 4 reads when decoding. This variable + * helps track that. + */ + private int modulus; + + /** + * Boolean flag to indicate the EOF has been reached. Once EOF has been reached, this Base64 object becomes useless, + * and must be thrown away. + */ + private boolean eof; + + /** + * Place holder for the 3 bytes we're dealing with for our base64 logic. Bitwise operations store and extract the + * base64 encoding or decoding from this variable. + */ + private int x; + + /** + * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode. + *

+ * When encoding the line length is 76, the line separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE. + *

+ * + *

+ * When decoding all variants are supported. + *

+ */ + public Base64() { + this(false); + } + + /** + * Creates a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode. + *

+ * When encoding the line length is 76, the line separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE. + *

+ * + *

+ * When decoding all variants are supported. + *

+ * + * @param urlSafe + * if true, URL-safe encoding is used. In most cases this should be set to + * false. + * @since 1.4 + */ + public Base64(boolean urlSafe) { + this(CHUNK_SIZE, CHUNK_SEPARATOR, urlSafe); + } + + /** + * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode. + *

+ * When encoding the line length is given in the constructor, the line separator is CRLF, and the encoding table is + * STANDARD_ENCODE_TABLE. + *

+ *

+ * Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data. + *

+ *

+ * When decoding all variants are supported. + *

+ * + * @param lineLength + * Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4). + * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding. + * @since 1.4 + */ + public Base64(int lineLength) { + this(lineLength, CHUNK_SEPARATOR); + } + + /** + * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode. + *

+ * When encoding the line length and line separator are given in the constructor, and the encoding table is + * STANDARD_ENCODE_TABLE. + *

+ *

+ * Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data. + *

+ *

+ * When decoding all variants are supported. + *

+ * + * @param lineLength + * Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4). + * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding. + * @param lineSeparator + * Each line of encoded data will end with this sequence of bytes. + * @throws IllegalArgumentException + * Thrown when the provided lineSeparator included some base64 characters. + * @since 1.4 + */ + public Base64(int lineLength, byte[] lineSeparator) { + this(lineLength, lineSeparator, false); + } + + /** + * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode. + *

+ * When encoding the line length and line separator are given in the constructor, and the encoding table is + * STANDARD_ENCODE_TABLE. + *

+ *

+ * Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data. + *

+ *

+ * When decoding all variants are supported. + *

+ * + * @param lineLength + * Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4). + * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding. + * @param lineSeparator + * Each line of encoded data will end with this sequence of bytes. + * @param urlSafe + * Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode + * operations. Decoding seamlessly handles both modes. + * @throws IllegalArgumentException + * The provided lineSeparator included some base64 characters. That's not going to work! + * @since 1.4 + */ + public Base64(int lineLength, byte[] lineSeparator, boolean urlSafe) { + if (lineSeparator == null) { + lineLength = 0; // disable chunk-separating + lineSeparator = CHUNK_SEPARATOR; // this just gets ignored + } + this.lineLength = lineLength > 0 ? (lineLength / 4) * 4 : 0; + this.lineSeparator = new byte[lineSeparator.length]; + System.arraycopy(lineSeparator, 0, this.lineSeparator, 0, lineSeparator.length); + if (lineLength > 0) { + this.encodeSize = 4 + lineSeparator.length; + } else { + this.encodeSize = 4; + } + this.decodeSize = this.encodeSize - 1; + if (containsBase64Byte(lineSeparator)) { + String sep = Utf8.toString(lineSeparator); + throw new IllegalArgumentException("lineSeperator must not contain base64 characters: [" + sep + "]"); + } + this.encodeTable = urlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE; + } + + /** + * Returns our current encode mode. True if we're URL-SAFE, false otherwise. + * + * @return true if we're in URL-SAFE mode, false otherwise. + * @since 1.4 + */ + public boolean isUrlSafe() { + return this.encodeTable == URL_SAFE_ENCODE_TABLE; + } + + /** + * Returns true if this Base64 object has buffered data for reading. + * + * @return true if there is Base64 object still available for reading. + */ + boolean hasData() { + return this.buffer != null; + } + + /** + * Returns the amount of buffered data available for reading. + * + * @return The amount of buffered data available for reading. + */ + int avail() { + return buffer != null ? pos - readPos : 0; + } + + /** Doubles our buffer. */ + private void resizeBuffer() { + if (buffer == null) { + buffer = new byte[DEFAULT_BUFFER_SIZE]; + pos = 0; + readPos = 0; + } else { + byte[] b = new byte[buffer.length * DEFAULT_BUFFER_RESIZE_FACTOR]; + System.arraycopy(buffer, 0, b, 0, buffer.length); + buffer = b; + } + } + + /** + * Extracts buffered data into the provided byte[] array, starting at position bPos, up to a maximum of bAvail + * bytes. Returns how many bytes were actually extracted. + * + * @param b + * byte[] array to extract the buffered data into. + * @param bPos + * position in byte[] array to start extraction at. + * @param bAvail + * amount of bytes we're allowed to extract. We may extract fewer (if fewer are available). + * @return The number of bytes successfully extracted into the provided byte[] array. + */ + int readResults(byte[] b, int bPos, int bAvail) { + if (buffer != null) { + int len = Math.min(avail(), bAvail); + if (buffer != b) { + System.arraycopy(buffer, readPos, b, bPos, len); + readPos += len; + if (readPos >= pos) { + buffer = null; + } + } else { + // Re-using the original consumer's output array is only + // allowed for one round. + buffer = null; + } + return len; + } + return eof ? -1 : 0; + } + + /** + * Sets the streaming buffer. This is a small optimization where we try to buffer directly to the consumer's output + * array for one round (if the consumer calls this method first) instead of starting our own buffer. + * + * @param out + * byte[] array to buffer directly to. + * @param outPos + * Position to start buffering into. + * @param outAvail + * Amount of bytes available for direct buffering. + */ + void setInitialBuffer(byte[] out, int outPos, int outAvail) { + // We can re-use consumer's original output array under + // special circumstances, saving on some System.arraycopy(). + if (out != null && out.length == outAvail) { + buffer = out; + pos = outPos; + readPos = outPos; + } + } + + /** + *

+ * Encodes all of the provided data, starting at inPos, for inAvail bytes. Must be called at least twice: once with + * the data to encode, and once with inAvail set to "-1" to alert encoder that EOF has been reached, so flush last + * remaining bytes (if not multiple of 3). + *

+ *

+ * Thanks to "commons" project in ws.apache.org for the bitwise operations, and general approach. + * http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/ + *

+ * + * @param in + * byte[] array of binary data to base64 encode. + * @param inPos + * Position to start reading data from. + * @param inAvail + * Amount of bytes available from input for encoding. + */ + void encode(byte[] in, int inPos, int inAvail) { + if (eof) { + return; + } + // inAvail < 0 is how we're informed of EOF in the underlying data we're + // encoding. + if (inAvail < 0) { + eof = true; + if (buffer == null || buffer.length - pos < encodeSize) { + resizeBuffer(); + } + switch (modulus) { + case 1 : + buffer[pos++] = encodeTable[(x >> 2) & MASK_6BITS]; + buffer[pos++] = encodeTable[(x << 4) & MASK_6BITS]; + // URL-SAFE skips the padding to further reduce size. + if (encodeTable == STANDARD_ENCODE_TABLE) { + buffer[pos++] = PAD; + buffer[pos++] = PAD; + } + break; + + case 2 : + buffer[pos++] = encodeTable[(x >> 10) & MASK_6BITS]; + buffer[pos++] = encodeTable[(x >> 4) & MASK_6BITS]; + buffer[pos++] = encodeTable[(x << 2) & MASK_6BITS]; + // URL-SAFE skips the padding to further reduce size. + if (encodeTable == STANDARD_ENCODE_TABLE) { + buffer[pos++] = PAD; + } + break; + default: + break; + } + if (lineLength > 0 && pos > 0) { + System.arraycopy(lineSeparator, 0, buffer, pos, lineSeparator.length); + pos += lineSeparator.length; + } + } else { + for (int i = 0; i < inAvail; i++) { + if (buffer == null || buffer.length - pos < encodeSize) { + resizeBuffer(); + } + modulus = (++modulus) % 3; + int b = in[inPos++]; + if (b < 0) { + b += 256; + } + x = (x << 8) + b; + if (0 == modulus) { + buffer[pos++] = encodeTable[(x >> 18) & MASK_6BITS]; + buffer[pos++] = encodeTable[(x >> 12) & MASK_6BITS]; + buffer[pos++] = encodeTable[(x >> 6) & MASK_6BITS]; + buffer[pos++] = encodeTable[x & MASK_6BITS]; + currentLinePos += 4; + if (lineLength > 0 && lineLength <= currentLinePos) { + System.arraycopy(lineSeparator, 0, buffer, pos, lineSeparator.length); + pos += lineSeparator.length; + currentLinePos = 0; + } + } + } + } + } + + /** + *

+ * Decodes all of the provided data, starting at inPos, for inAvail bytes. Should be called at least twice: once + * with the data to decode, and once with inAvail set to "-1" to alert decoder that EOF has been reached. The "-1" + * call is not necessary when decoding, but it doesn't hurt, either. + *

+ *

+ * Ignores all non-base64 characters. This is how chunked (e.g. 76 character) data is handled, since CR and LF are + * silently ignored, but has implications for other bytes, too. This method subscribes to the garbage-in, + * garbage-out philosophy: it will not check the provided data for validity. + *

+ *

+ * Thanks to "commons" project in ws.apache.org for the bitwise operations, and general approach. + * http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/ + *

+ * + * @param in + * byte[] array of ascii data to base64 decode. + * @param inPos + * Position to start reading data from. + * @param inAvail + * Amount of bytes available from input for encoding. + */ + void decode(byte[] in, int inPos, int inAvail) { + if (eof) { + return; + } + if (inAvail < 0) { + eof = true; + } + for (int i = 0; i < inAvail; i++) { + if (buffer == null || buffer.length - pos < decodeSize) { + resizeBuffer(); + } + byte b = in[inPos++]; + if (b == PAD) { + // We're done. + eof = true; + break; + } else { + if (b >= 0 && b < DECODE_TABLE.length) { + int result = DECODE_TABLE[b]; + if (result >= 0) { + modulus = (++modulus) % 4; + x = (x << 6) + result; + if (modulus == 0) { + buffer[pos++] = (byte) ((x >> 16) & MASK_8BITS); + buffer[pos++] = (byte) ((x >> 8) & MASK_8BITS); + buffer[pos++] = (byte) (x & MASK_8BITS); + } + } + } + } + } + + // Two forms of EOF as far as base64 decoder is concerned: actual + // EOF (-1) and first time '=' character is encountered in stream. + // This approach makes the '=' padding characters completely optional. + if (eof && modulus != 0) { + x = x << 6; + switch (modulus) { + case 2 : + x = x << 6; + buffer[pos++] = (byte) ((x >> 16) & MASK_8BITS); + break; + case 3 : + buffer[pos++] = (byte) ((x >> 16) & MASK_8BITS); + buffer[pos++] = (byte) ((x >> 8) & MASK_8BITS); + break; + default : + break; + } + } + } + + /** + * Returns whether or not the octet is in the base 64 alphabet. + * + * @param octet + * The value to test + * @return true if the value is defined in the the base 64 alphabet, false otherwise. + * @since 1.4 + */ + public static boolean isBase64(byte octet) { + return octet == PAD || octet >= 0 && octet < DECODE_TABLE.length && DECODE_TABLE[octet] != -1; + } + + /** + * Tests a given byte array to see if it contains only valid characters within the Base64 alphabet. Currently the + * method treats whitespace as valid. + * + * @param arrayOctet + * byte array to test + * @return true if all bytes are valid characters in the Base64 alphabet or if the byte array is empty; + * false, otherwise + */ + public static boolean isArrayByteBase64(byte[] arrayOctet) { + for (int i = 0; i < arrayOctet.length; i++) { + if (!isBase64(arrayOctet[i]) && !isWhiteSpace(arrayOctet[i])) { + return false; + } + } + return true; + } + + /** + * Tests a given byte array to see if it contains only valid characters within the Base64 alphabet. + * + * @param arrayOctet + * byte array to test + * @return true if any byte is a valid character in the Base64 alphabet; false herwise + */ + private static boolean containsBase64Byte(byte[] arrayOctet) { + for (int i = 0; i < arrayOctet.length; i++) { + if (isBase64(arrayOctet[i])) { + return true; + } + } + return false; + } + + /** + * Encodes binary data using the base64 algorithm but does not chunk the output. + * + * @param binaryData + * binary data to encode + * @return byte[] containing Base64 characters in their UTF-8 representation. + */ + public static byte[] encodeBase64(byte[] binaryData) { + return encodeBase64(binaryData, false); + } + + /** + * Encodes binary data using the base64 algorithm into 76 character blocks separated by CRLF. + * + * @param binaryData + * binary data to encode + * @return String containing Base64 characters. + * @since 1.4 + */ + public static String encodeBase64String(byte[] binaryData) { + return Utf8.toString(encodeBase64(binaryData, true)); + } + + /** + * Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The + * url-safe variation emits - and _ instead of + and / characters. + * + * @param binaryData + * binary data to encode + * @return byte[] containing Base64 characters in their UTF-8 representation. + * @since 1.4 + */ + public static byte[] encodeBase64URLSafe(byte[] binaryData) { + return encodeBase64(binaryData, false, true); + } + + /** + * Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The + * url-safe variation emits - and _ instead of + and / characters. + * + * @param binaryData + * binary data to encode + * @return String containing Base64 characters + * @since 1.4 + */ + public static String encodeBase64URLSafeString(byte[] binaryData) { + return Utf8.toString(encodeBase64(binaryData, false, true)); + } + + /** + * Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocks + * + * @param binaryData + * binary data to encode + * @return Base64 characters chunked in 76 character blocks + */ + public static byte[] encodeBase64Chunked(byte[] binaryData) { + return encodeBase64(binaryData, true); + } + + /** + * Decodes an Object using the base64 algorithm. This method is provided in order to satisfy the requirements of the + * Decoder interface, and will throw a DecoderException if the supplied object is not of type byte[] or String. + * + * @param pObject + * Object to decode + * @return An object (of type byte[]) containing the binary data which corresponds to the byte[] or String supplied. + */ + public Object decode(Object pObject) { + if (pObject instanceof byte[]) { + return decode((byte[]) pObject); + } else if (pObject instanceof String) { + return decode((String) pObject); + } else { + throw new IllegalArgumentException("Parameter supplied to Base64 decode is not a byte[] or a String"); + } + } + + /** + * Decodes a String containing containing characters in the Base64 alphabet. + * + * @param pArray + * A String containing Base64 character data + * @return a byte array containing binary data + * @since 1.4 + */ + public byte[] decode(String pArray) { + return decode(Utf8.toBytes(pArray)); + } + + /** + * Decodes a byte[] containing containing characters in the Base64 alphabet. + * + * @param pArray + * A byte array containing Base64 character data + * @return a byte array containing binary data + */ + public byte[] decode(byte[] pArray) { + reset(); + if (pArray == null || pArray.length == 0) { + return pArray; + } + long len = (pArray.length * 3) / 4; + byte[] buf = new byte[(int) len]; + setInitialBuffer(buf, 0, buf.length); + decode(pArray, 0, pArray.length); + decode(pArray, 0, -1); // Notify decoder of EOF. + + // Would be nice to just return buf (like we sometimes do in the encode + // logic), but we have no idea what the line-length was (could even be + // variable). So we cannot determine ahead of time exactly how big an + // array is necessary. Hence the need to construct a 2nd byte array to + // hold the final result: + + byte[] result = new byte[pos]; + readResults(result, 0, result.length); + return result; + } + + /** + * Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks. + * + * @param binaryData + * Array containing binary data to encode. + * @param isChunked + * if true this encoder will chunk the base64 output into 76 character blocks + * @return Base64-encoded data. + * @throws IllegalArgumentException + * Thrown when the input array needs an output array bigger than {@link Integer#MAX_VALUE} + */ + public static byte[] encodeBase64(byte[] binaryData, boolean isChunked) { + return encodeBase64(binaryData, isChunked, false); + } + + /** + * Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks. + * + * @param binaryData + * Array containing binary data to encode. + * @param isChunked + * if true this encoder will chunk the base64 output into 76 character blocks + * @param urlSafe + * if true this encoder will emit - and _ instead of the usual + and / characters. + * @return Base64-encoded data. + * @throws IllegalArgumentException + * Thrown when the input array needs an output array bigger than {@link Integer#MAX_VALUE} + * @since 1.4 + */ + public static byte[] encodeBase64(byte[] binaryData, boolean isChunked, boolean urlSafe) { + return encodeBase64(binaryData, isChunked, urlSafe, Integer.MAX_VALUE); + } + + /** + * Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks. + * + * @param binaryData + * Array containing binary data to encode. + * @param isChunked + * if true this encoder will chunk the base64 output into 76 character blocks + * @param urlSafe + * if true this encoder will emit - and _ instead of the usual + and / characters. + * @param maxResultSize + * The maximum result size to accept. + * @return Base64-encoded data. + * @throws IllegalArgumentException + * Thrown when the input array needs an output array bigger than maxResultSize + * @since 1.4 + */ + public static byte[] encodeBase64(byte[] binaryData, boolean isChunked, boolean urlSafe, int maxResultSize) { + if (binaryData == null || binaryData.length == 0) { + return binaryData; + } + + long len = getEncodeLength(binaryData, CHUNK_SIZE, CHUNK_SEPARATOR); + if (len > maxResultSize) { + throw new IllegalArgumentException("Input array too big, the output array would be bigger (" + + len + ") than the specified maxium size of " + maxResultSize); + } + + Base64 b64 = isChunked ? new Base64(urlSafe) : new Base64(0, CHUNK_SEPARATOR, urlSafe); + return b64.encode(binaryData); + } + + /** + * Decodes a Base64 String into octets + * + * @param base64String + * String containing Base64 data + * @return Array containing decoded data. + * @since 1.4 + */ + public static byte[] decodeBase64(String base64String) { + return new Base64().decode(base64String); + } + + /** + * Decodes Base64 data into octets + * + * @param base64Data + * Byte array containing Base64 data + * @return Array containing decoded data. + */ + public static byte[] decodeBase64(byte[] base64Data) { + return new Base64().decode(base64Data); + } + + /** + * Discards any whitespace from a base-64 encoded block. + * + * @param data + * The base-64 encoded data to discard the whitespace from. + * @return The data, less whitespace (see RFC 2045). + * @deprecated This method is no longer needed + */ + static byte[] discardWhitespace(byte[] data) { + byte[] groomedData = new byte[data.length]; + int bytesCopied = 0; + for (int i = 0; i < data.length; i++) { + switch (data[i]) { + case ' ' : + case '\n' : + case '\r' : + case '\t' : + break; + default : + groomedData[bytesCopied++] = data[i]; + } + } + byte[] packedData = new byte[bytesCopied]; + System.arraycopy(groomedData, 0, packedData, 0, bytesCopied); + return packedData; + } + + /** + * Checks if a byte value is whitespace or not. + * + * @param byteToCheck + * the byte to check + * @return true if byte is whitespace, false otherwise + */ + private static boolean isWhiteSpace(byte byteToCheck) { + switch (byteToCheck) { + case ' ' : + case '\n' : + case '\r' : + case '\t' : + return true; + default : + return false; + } + } + + // Implementation of the Encoder Interface + + /** + * Encodes an Object using the base64 algorithm. This method is provided in order to satisfy the requirements of the + * Encoder interface, and will throw an EncoderException if the supplied object is not of type byte[]. + * + * @param pObject + * Object to encode + * @return An object (of type byte[]) containing the base64 encoded data which corresponds to the byte[] supplied. + */ + public Object encode(Object pObject) { + if (!(pObject instanceof byte[])) { + throw new IllegalArgumentException("Parameter supplied to Base64 encode is not a byte[]"); + } + return encode((byte[]) pObject); + } + + /** + * Encodes a byte[] containing binary data, into a String containing characters in the Base64 alphabet. + * + * @param pArray + * a byte array containing binary data + * @return A String containing only Base64 character data + * @since 1.4 + */ + public String encodeToString(byte[] pArray) { + return Utf8.toString(encode(pArray)); + } + + /** + * Encodes a byte[] containing binary data, into a byte[] containing characters in the Base64 alphabet. + * + * @param pArray + * a byte array containing binary data + * @return A byte array containing only Base64 character data + */ + public byte[] encode(byte[] pArray) { + reset(); + if (pArray == null || pArray.length == 0) { + return pArray; + } + long len = getEncodeLength(pArray, lineLength, lineSeparator); + byte[] buf = new byte[(int) len]; + setInitialBuffer(buf, 0, buf.length); + encode(pArray, 0, pArray.length); + encode(pArray, 0, -1); // Notify encoder of EOF. + // Encoder might have resized, even though it was unnecessary. + if (buffer != buf) { + readResults(buf, 0, buf.length); + } + // In URL-SAFE mode we skip the padding characters, so sometimes our + // final length is a bit smaller. + if (isUrlSafe() && pos < buf.length) { + byte[] smallerBuf = new byte[pos]; + System.arraycopy(buf, 0, smallerBuf, 0, pos); + buf = smallerBuf; + } + return buf; + } + + /** + * Pre-calculates the amount of space needed to base64-encode the supplied array. + * + * @param pArray byte[] array which will later be encoded + * @param chunkSize line-length of the output (<= 0 means no chunking) between each + * chunkSeparator (e.g. CRLF). + * @param chunkSeparator the sequence of bytes used to separate chunks of output (e.g. CRLF). + * + * @return amount of space needed to encoded the supplied array. Returns + * a long since a max-len array will require Integer.MAX_VALUE + 33%. + */ + private static long getEncodeLength(byte[] pArray, int chunkSize, byte[] chunkSeparator) { + // base64 always encodes to multiples of 4. + chunkSize = (chunkSize / 4) * 4; + + long len = (pArray.length * 4) / 3; + long mod = len % 4; + if (mod != 0) { + len += 4 - mod; + } + if (chunkSize > 0) { + boolean lenChunksPerfectly = len % chunkSize == 0; + len += (len / chunkSize) * chunkSeparator.length; + if (!lenChunksPerfectly) { + len += chunkSeparator.length; + } + } + return len; + } + + // Implementation of integer encoding used for crypto + /** + * Decodes a byte64-encoded integer according to crypto standards such as W3C's XML-Signature + * + * @param pArray + * a byte array containing base64 character data + * @return A BigInteger + * @since 1.4 + */ + public static BigInteger decodeInteger(byte[] pArray) { + return new BigInteger(1, decodeBase64(pArray)); + } + + /** + * Encodes to a byte64-encoded integer according to crypto standards such as W3C's XML-Signature + * + * @param bigInt + * a BigInteger + * @return A byte array containing base64 character data + * @throws NullPointerException + * if null is passed in + * @since 1.4 + */ + public static byte[] encodeInteger(BigInteger bigInt) { + if (bigInt == null) { + throw new NullPointerException("encodeInteger called with null parameter"); + } + return encodeBase64(toIntegerBytes(bigInt), false); + } + + /** + * Returns a byte-array representation of a BigInteger without sign bit. + * + * @param bigInt + * BigInteger to be converted + * @return a byte array representation of the BigInteger parameter + */ + static byte[] toIntegerBytes(BigInteger bigInt) { + int bitlen = bigInt.bitLength(); + // round bitlen + bitlen = ((bitlen + 7) >> 3) << 3; + byte[] bigBytes = bigInt.toByteArray(); + + if (bigInt.bitLength() % 8 != 0 && (bigInt.bitLength() / 8 + 1) == bitlen / 8) { + return bigBytes; + } + // set up params for copying everything but sign bit + int startSrc = 0; + int len = bigBytes.length; + + // if bigInt is exactly byte-aligned, just skip signbit in copy + if (bigInt.bitLength() % 8 == 0) { + startSrc = 1; + len--; + } + int startDst = bitlen / 8 - len; // to pad w/ nulls as per spec + byte[] resizedBytes = new byte[bitlen / 8]; + System.arraycopy(bigBytes, startSrc, resizedBytes, startDst, len); + return resizedBytes; + } + + /** + * Resets this Base64 object to its initial newly constructed state. + */ + private void reset() { + buffer = null; + pos = 0; + readPos = 0; + currentLinePos = 0; + modulus = 0; + eof = false; + } + +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/Base64InputStream.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/Base64InputStream.java b/kerby-util/src/main/java/org/apache/kerby/util/Base64InputStream.java new file mode 100644 index 0000000..52bab54 --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/Base64InputStream.java @@ -0,0 +1,174 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.kerby.util; + +import java.io.FilterInputStream; +import java.io.IOException; +import java.io.InputStream; + +/** + * Provides Base64 encoding and decoding in a streaming fashion (unlimited size). When encoding the default lineLength + * is 76 characters and the default lineEnding is CRLF, but these can be overridden by using the appropriate + * constructor. + *

+ * The default behaviour of the Base64InputStream is to DECODE, whereas the default behaviour of the Base64OutputStream + * is to ENCODE, but this behaviour can be overridden by using a different constructor. + *

+ *

+ * This class implements section 6.8. Base64 Content-Transfer-Encoding from RFC 2045 Multipurpose + * Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies by Freed and Borenstein. + *

+ *

+ * Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode + * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc). + *

+ * + * @author Apache Software Foundation + * @version $Id: Base64InputStream.java 155 2009-09-17 21:00:58Z julius $ + * @see RFC 2045 + * @since 1.4 + */ +public class Base64InputStream extends FilterInputStream { + + private final boolean doEncode; + + private final Base64 base64; + + private final byte[] singleByte = new byte[1]; + + /** + * Creates a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream. + * + * @param in + * InputStream to wrap. + */ + public Base64InputStream(InputStream in) { + this(in, false); + } + + /** + * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original + * provided InputStream. + * + * @param in + * InputStream to wrap. + * @param doEncode + * true if we should encode all data read from us, false if we should decode. + */ + public Base64InputStream(InputStream in, boolean doEncode) { + super(in); + this.doEncode = doEncode; + this.base64 = new Base64(); + } + + /** + * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original + * provided InputStream. + * + * @param in + * InputStream to wrap. + * @param doEncode + * true if we should encode all data read from us, false if we should decode. + * @param lineLength + * If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to + * nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is + * false, lineLength is ignored. + * @param lineSeparator + * If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n). + * If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored. + */ + public Base64InputStream(InputStream in, boolean doEncode, int lineLength, byte[] lineSeparator) { + super(in); + this.doEncode = doEncode; + this.base64 = new Base64(lineLength, lineSeparator); + } + + /** + * Reads one byte from this input stream. + * + * @return the byte as an integer in the range 0 to 255. Returns -1 if EOF has been reached. + * @throws java.io.IOException + * if an I/O error occurs. + */ + public int read() throws IOException { + int r = read(singleByte, 0, 1); + while (r == 0) { + r = read(singleByte, 0, 1); + } + if (r > 0) { + return singleByte[0] < 0 ? 256 + singleByte[0] : singleByte[0]; + } + return -1; + } + + /** + * Attempts to read len bytes into the specified b array starting at offset + * from this InputStream. + * + * @param b + * destination byte array + * @param offset + * where to start writing the bytes + * @param len + * maximum number of bytes to read + * + * @return number of bytes read + * @throws java.io.IOException + * if an I/O error occurs. + * @throws NullPointerException + * if the byte array parameter is null + * @throws IndexOutOfBoundsException + * if offset, len or buffer size are invalid + */ + public int read(byte[] b, int offset, int len) throws IOException { + if (b == null) { + throw new NullPointerException(); + } else if (offset < 0 || len < 0) { + throw new IndexOutOfBoundsException(); + } else if (offset > b.length || offset + len > b.length) { + throw new IndexOutOfBoundsException(); + } else if (len == 0) { + return 0; + } else { + if (!base64.hasData()) { + byte[] buf = new byte[doEncode ? 4096 : 8192]; + int c = in.read(buf); + // A little optimization to avoid System.arraycopy() + // when possible. + if (c > 0 && b.length == len) { + base64.setInitialBuffer(b, offset, len); + } + if (doEncode) { + base64.encode(buf, 0, c); + } else { + base64.decode(buf, 0, c); + } + } + return base64.readResults(b, offset, len); + } + } + + /** + * {@inheritDoc} + * + * @return false + */ + public boolean markSupported() { + return false; // not an easy job to support marks + } +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/Base64OutputStream.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/Base64OutputStream.java b/kerby-util/src/main/java/org/apache/kerby/util/Base64OutputStream.java new file mode 100644 index 0000000..b2e09ba --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/Base64OutputStream.java @@ -0,0 +1,198 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.kerby.util; + +import java.io.FilterOutputStream; +import java.io.IOException; +import java.io.OutputStream; + +/** + * Provides Base64 encoding and decoding in a streaming fashion (unlimited size). When encoding the default lineLength + * is 76 characters and the default lineEnding is CRLF, but these can be overridden by using the appropriate + * constructor. + *

+ * The default behaviour of the Base64OutputStream is to ENCODE, whereas the default behaviour of the Base64InputStream + * is to DECODE. But this behaviour can be overridden by using a different constructor. + *

+ *

+ * This class implements section 6.8. Base64 Content-Transfer-Encoding from RFC 2045 Multipurpose + * Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies by Freed and Borenstein. + *

+ *

+ * Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode + * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc). + *

+ * + * @author Apache Software Foundation + * @version $Id$ + * @see RFC 2045 + * @since 1.4 + */ +public class Base64OutputStream extends FilterOutputStream { + private final boolean doEncode; + + private final Base64 base64; + + private final byte[] singleByte = new byte[1]; + + /** + * Creates a Base64OutputStream such that all data written is Base64-encoded to the original provided OutputStream. + * + * @param out + * OutputStream to wrap. + */ + public Base64OutputStream(OutputStream out) { + this(out, true); + } + + /** + * Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the + * original provided OutputStream. + * + * @param out + * OutputStream to wrap. + * @param doEncode + * true if we should encode all data written to us, false if we should decode. + */ + public Base64OutputStream(OutputStream out, boolean doEncode) { + super(out); + this.doEncode = doEncode; + this.base64 = new Base64(); + } + + /** + * Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the + * original provided OutputStream. + * + * @param out + * OutputStream to wrap. + * @param doEncode + * true if we should encode all data written to us, false if we should decode. + * @param lineLength + * If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to + * nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is + * false, lineLength is ignored. + * @param lineSeparator + * If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n). + * If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored. + */ + public Base64OutputStream(OutputStream out, boolean doEncode, int lineLength, byte[] lineSeparator) { + super(out); + this.doEncode = doEncode; + this.base64 = new Base64(lineLength, lineSeparator); + } + + /** + * Writes the specified byte to this output stream. + * + * @param i + * source byte + * @throws java.io.IOException + * if an I/O error occurs. + */ + public void write(int i) throws IOException { + singleByte[0] = (byte) i; + write(singleByte, 0, 1); + } + + /** + * Writes len bytes from the specified b array starting at offset to this + * output stream. + * + * @param b + * source byte array + * @param offset + * where to start reading the bytes + * @param len + * maximum number of bytes to write + * + * @throws java.io.IOException + * if an I/O error occurs. + * @throws NullPointerException + * if the byte array parameter is null + * @throws IndexOutOfBoundsException + * if offset, len or buffer size are invalid + */ + public void write(byte[] b, int offset, int len) throws IOException { + if (b == null) { + throw new NullPointerException(); + } else if (offset < 0 || len < 0) { + throw new IndexOutOfBoundsException(); + } else if (offset > b.length || offset + len > b.length) { + throw new IndexOutOfBoundsException(); + } else if (len > 0) { + if (doEncode) { + base64.encode(b, offset, len); + } else { + base64.decode(b, offset, len); + } + flush(false); + } + } + + /** + * Flushes this output stream and forces any buffered output bytes to be written out to the stream. If propogate is + * true, the wrapped stream will also be flushed. + * + * @param propogate + * boolean flag to indicate whether the wrapped OutputStream should also be flushed. + * @throws java.io.IOException + * if an I/O error occurs. + */ + private void flush(boolean propogate) throws IOException { + int avail = base64.avail(); + if (avail > 0) { + byte[] buf = new byte[avail]; + int c = base64.readResults(buf, 0, avail); + if (c > 0) { + out.write(buf, 0, c); + } + } + if (propogate) { + out.flush(); + } + } + + /** + * Flushes this output stream and forces any buffered output bytes to be written out to the stream. + * + * @throws java.io.IOException + * if an I/O error occurs. + */ + public void flush() throws IOException { + flush(true); + } + + /** + * Closes this output stream and releases any system resources associated with the stream. + * + * @throws java.io.IOException + * if an I/O error occurs. + */ + public void close() throws IOException { + // Notify encoder of EOF (-1). + if (doEncode) { + base64.encode(singleByte, 0, -1); + } else { + base64.decode(singleByte, 0, -1); + } + flush(); + out.close(); + } + +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/Hex.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/Hex.java b/kerby-util/src/main/java/org/apache/kerby/util/Hex.java new file mode 100644 index 0000000..ec61298 --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/Hex.java @@ -0,0 +1,77 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + * + */ + +package org.apache.kerby.util; + +/** + * Utility class for dealing with hex-encoding of binary data. + * + * @author juliusdavies@gmail.com + * @since 13-Nov-2007 + */ +public class Hex { + + public static byte[] decode(String s) { + byte[] b = new byte[s.length() / 2]; + for (int i = 0; i < b.length; i++) { + String hex = s.substring(2 * i, 2 * (i + 1)); + b[i] = (byte) Integer.parseInt(hex, 16); + } + return b; + } + + public static byte[] decode(byte[] hexString) { + byte[] b = new byte[hexString.length / 2]; + char[] chars = new char[2]; + for (int i = 0; i < b.length; i++) { + chars[0] = (char) hexString[2 * i]; + chars[1] = (char) hexString[2 * i + 1]; + String hex = new String(chars); + b[i] = (byte) Integer.parseInt(hex, 16); + } + return b; + } + + public static String encode(byte[] b) { + return encode(b, 0, b.length); + } + + public static String encode(byte[] b, int offset, int length) { + StringBuffer buf = new StringBuffer(); + int len = Math.min(offset + length, b.length); + for (int i = offset; i < len; i++) { + int c = (int) b[i]; + if (c < 0) { + c = c + 256; + } + if (c >= 0 && c <= 15) { + buf.append('0'); + } + buf.append(Integer.toHexString(c)); + } + return buf.toString(); + } + +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/HexUtil.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/HexUtil.java b/kerby-util/src/main/java/org/apache/kerby/util/HexUtil.java new file mode 100644 index 0000000..39442ee --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/HexUtil.java @@ -0,0 +1,59 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.kerby.util; + +public final class HexUtil { + private HexUtil() { } + + private static final String HEX_CHARS_STR = "0123456789ABCDEF"; + private static final char[] HEX_CHARS = HEX_CHARS_STR.toCharArray(); + + /** + * Convert bytes into format as: + * 02020080 + */ + public static String bytesToHex(byte[] bytes) { + int len = bytes.length * 2; + char[] hexChars = new char[len]; + for (int j = 0; j < bytes.length; j++) { + int v = bytes[j] & 0xFF; + hexChars[j * 2] = HEX_CHARS[v >>> 4]; + hexChars[j * 2 + 1] = HEX_CHARS[v & 0x0F]; + } + + return new String(hexChars); + } + + /** + * Convert hex string like follows into byte array + * 02020080 + */ + public static byte[] hex2bytes(String hexString) { + hexString = hexString.toUpperCase(); + int len = hexString.length() / 2; + byte[] bytes = new byte[len]; + char[] hexChars = hexString.toCharArray(); + for (int i = 0, j = 0; i < len; ++i) { + bytes[i] = (byte) ((HEX_CHARS_STR.indexOf(hexChars[j++]) << 4) + HEX_CHARS_STR.indexOf(hexChars[j++])); + } + + return bytes; + } +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java b/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java new file mode 100644 index 0000000..3e52932 --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java @@ -0,0 +1,106 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.kerby.util; + +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.nio.ByteBuffer; +import java.nio.channels.FileChannel; + +/** + * Some IO and file related utilities. + */ +public final class IOUtil { + private IOUtil() { } + + public static byte[] readInputStream(InputStream in) throws IOException { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + byte[] buffer = new byte[1024]; + int length = 0; + while ((length = in.read(buffer)) != -1) { + baos.write(buffer, 0, length); + } + return baos.toByteArray(); + } + + public static void readInputStream(InputStream in, + byte[] buf) throws IOException { + int toRead = buf.length; + int off = 0; + while (toRead > 0) { + int ret = in.read(buf, off, toRead); + if (ret < 0) { + throw new IOException("Bad inputStream, premature EOF"); + } + toRead -= ret; + off += ret; + } + } + + /** + * Read an input stream and return the content as string assuming UTF8. + * @param in + * @return + * @throws IOException + */ + public static String readInput(InputStream in) throws IOException { + byte[] content = readInputStream(in); + return Utf8.toString(content); + } + + /** + * Read a file and return the content as string assuming UTF8. + * @param file + * @return + * @throws IOException + */ + public static String readFile(File file) throws IOException { + long len = 0; + if (file.length() >= Integer.MAX_VALUE) { + throw new IOException("Too large file, unexpected!"); + } else { + len = file.length(); + } + byte[] buf = new byte[(int) len]; + + InputStream is = new FileInputStream(file); + readInputStream(is, buf); + + return Utf8.toString(buf); + } + + /** + * Write a file with the content assuming UTF8. + * @param content + * @param file + * @throws IOException + */ + public static void writeFile(String content, File file) throws IOException { + FileOutputStream outputStream = new FileOutputStream(file); + FileChannel fc = outputStream.getChannel(); + + ByteBuffer buffer = ByteBuffer.wrap(Utf8.toBytes(content)); + fc.write(buffer); + } +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/NetworkUtil.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/NetworkUtil.java b/kerby-util/src/main/java/org/apache/kerby/util/NetworkUtil.java new file mode 100644 index 0000000..6f8c57d --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/NetworkUtil.java @@ -0,0 +1,48 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.kerby.util; + +import java.io.IOException; +import java.net.ServerSocket; + +/** + * Some network related utilities. + */ +public final class NetworkUtil { + private NetworkUtil() { } + + /** + * Get a server socket point for server, either TCP or UDP. + * @return server socket point + */ + public static int getServerPort() { + int serverPort = 0; + + try { + ServerSocket serverSocket = new ServerSocket(0); + serverPort = serverSocket.getLocalPort(); + serverSocket.close(); + } catch (IOException e) { + throw new RuntimeException("Failed to get a server socket point"); + } + + return serverPort; + } +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/OSUtil.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/OSUtil.java b/kerby-util/src/main/java/org/apache/kerby/util/OSUtil.java new file mode 100644 index 0000000..d6dbcd2 --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/OSUtil.java @@ -0,0 +1,62 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.kerby.util; + +/** + * An OS related utility, mainly detecting what's the platform it's rnning on. + */ +public final class OSUtil { + private OSUtil() { } + + private static final String OS = + System.getProperty("os.name").toLowerCase(); + + public static boolean isWindows() { + return OS.contains("win"); + } + + public static boolean isMac() { + return OS.contains("mac"); + } + + public static boolean isUnix() { + return OS.contains("nix") || OS.contains("nux") || OS.contains("aix"); + } + + public static boolean isSolaris() { + return OS.contains("sunos"); + } + + public static void main(String[] args) { + System.out.println(OS); + + if (isWindows()) { + System.out.println("This is Windows"); + } else if (isMac()) { + System.out.println("This is Mac"); + } else if (isUnix()) { + System.out.println("This is Unix or Linux"); + } else if (isSolaris()) { + System.out.println("This is Solaris"); + } else { + System.out.println("Your OS is not support!!"); + } + } +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/SysUtil.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/SysUtil.java b/kerby-util/src/main/java/org/apache/kerby/util/SysUtil.java new file mode 100644 index 0000000..d607871 --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/SysUtil.java @@ -0,0 +1,35 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.kerby.util; + +import java.io.File; + +/** + * A system related utility. + */ +public final class SysUtil { + private SysUtil() { } + + public static File getTempDir() { + String tmpDir = System.getProperty("java.io.tmpdir"); + return new File(tmpDir); + } + +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/kerby-util/src/main/java/org/apache/kerby/util/Utf8.java ---------------------------------------------------------------------- diff --git a/kerby-util/src/main/java/org/apache/kerby/util/Utf8.java b/kerby-util/src/main/java/org/apache/kerby/util/Utf8.java new file mode 100644 index 0000000..4952665 --- /dev/null +++ b/kerby-util/src/main/java/org/apache/kerby/util/Utf8.java @@ -0,0 +1,42 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.kerby.util; + +import java.io.UnsupportedEncodingException; + +public final class Utf8 { + private Utf8() { } + + public static String toString(byte[] bytes) { + try { + return new String(bytes, "UTF-8"); + } catch (UnsupportedEncodingException uee) { + throw new RuntimeException("UTF8 unavailable", uee); + } + } + + public static byte[] toBytes(String s) { + try { + return s.getBytes("UTF-8"); + } catch (UnsupportedEncodingException uee) { + throw new RuntimeException("UTF8 unavailable", uee); + } + } +} http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/lib/README.md ---------------------------------------------------------------------- diff --git a/lib/README.md b/lib/README.md deleted file mode 100644 index 92c7329..0000000 --- a/lib/README.md +++ /dev/null @@ -1 +0,0 @@ -This contains all the libraries that the Kerberos implementation relies on. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/lib/kerby-config/README ---------------------------------------------------------------------- diff --git a/lib/kerby-config/README b/lib/kerby-config/README deleted file mode 100644 index 37eb019..0000000 --- a/lib/kerby-config/README +++ /dev/null @@ -1 +0,0 @@ -An unified configuration API that crosses various popular configuration formats like XML, JSON, INI and etc. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/lib/kerby-config/pom.xml ---------------------------------------------------------------------- diff --git a/lib/kerby-config/pom.xml b/lib/kerby-config/pom.xml deleted file mode 100644 index 1499d09..0000000 --- a/lib/kerby-config/pom.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - org.apache.kerby - lib - 1.0-SNAPSHOT - - - 4.0.0 - - kerby-config - Kerby Config - Kerby config library - - - - org.slf4j - slf4j-api - - - http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/6bb66073/lib/kerby-config/src/main/java/org/apache/kerby/config/Conf.java ---------------------------------------------------------------------- diff --git a/lib/kerby-config/src/main/java/org/apache/kerby/config/Conf.java b/lib/kerby-config/src/main/java/org/apache/kerby/config/Conf.java deleted file mode 100644 index a207f52..0000000 --- a/lib/kerby-config/src/main/java/org/apache/kerby/config/Conf.java +++ /dev/null @@ -1,342 +0,0 @@ -/** - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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.apache.kerby.config; - -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.File; -import java.io.IOException; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Properties; -import java.util.Set; - -public class Conf implements Config { - private static final Logger LOGGER = LoggerFactory.getLogger(Conf.class); - - private List resourceConfigs; - private final ConfigImpl config; - private final Map setValues; - private boolean needReload; - - public Conf() { - this.resourceConfigs = new ArrayList(1); - this.config = new ConfigImpl("Conf"); - this.setValues = new HashMap<>(10); - this.needReload = true; - - addMapConfig(setValues); - } - - public void addXmlConfig(File xmlFile) throws IOException { - addResource(Resource.createXmlResource(xmlFile)); - } - - public void addIniConfig(File iniFile) throws IOException { - addResource(Resource.createIniResource(iniFile)); - } - - public void addJsonConfig(File jsonFile) throws IOException { - addResource(Resource.createJsonResource(jsonFile)); - } - - public void addPropertiesConfig(File propertiesFile) throws IOException { - addResource(Resource.createPropertiesFileResource(propertiesFile)); - } - - public void addPropertiesConfig(Properties propertiesConfig) { - addResource(Resource.createPropertiesResource(propertiesConfig)); - } - - public void addMapConfig(Map mapConfig) { - addResource(Resource.createMapResource(mapConfig)); - } - - public void addResource(Resource resource) { - ConfigLoader loader = getLoader(resource); - resourceConfigs.add(loader); - needReload = true; - } - - private static ConfigLoader getLoader(Resource resource) { - ConfigLoader loader = null; - - Class loaderClass = resource.getFormat().getLoaderClass(); - try { - loader = loaderClass.newInstance(); - } catch (Exception e) { - LOGGER.error("Failed to create " + Conf.class.getPackage().getName() - + " for " + loaderClass.getName(), e); - throw new RuntimeException("Failed to create " - + Conf.class.getPackage().getName() + " for " + loaderClass.getName(), e); - } - loader.setResource(resource); - return loader; - } - - private void checkAndLoad() { - if (needReload) { - reload(); - needReload = false; - } - } - - public void reload() { - config.reset(); - - for (ConfigLoader loader : resourceConfigs) { - Config loaded = loader.load(); - config.add(loaded); - } - } - - @Override - public String getResource() { - checkAndLoad(); - return config.getResource(); - } - - @Override - public Set getNames() { - checkAndLoad(); - return config.getNames(); - } - - @Override - public String getString(String name) { - checkAndLoad(); - return config.getString(name); - } - - @Override - public String getString(ConfigKey name) { - checkAndLoad(); - return config.getString(name); - } - - @Override - public String getString(String name, String defaultValue) { - checkAndLoad(); - return config.getString(name, defaultValue); - } - - @Override - public void setString(String name, String value) { - setValues.put(name, value); - } - - @Override - public void setString(ConfigKey name, String value) { - setString(name.getPropertyKey(), value); - } - - @Override - public String getTrimmed(String name) { - checkAndLoad(); - return config.getTrimmed(name); - } - - @Override - public String getTrimmed(ConfigKey name) { - checkAndLoad(); - return config.getTrimmed(name); - } - - @Override - public Boolean getBoolean(String name) { - checkAndLoad(); - return config.getBoolean(name); - } - - @Override - public Boolean getBoolean(ConfigKey name) { - checkAndLoad(); - return config.getBoolean(name); - } - - @Override - public Boolean getBoolean(String name, boolean defaultValue) { - checkAndLoad(); - return config.getBoolean(name, defaultValue); - } - - @Override - public void setBoolean(String name, boolean value) { - setString(name, String.valueOf(value)); - } - - @Override - public void setBoolean(ConfigKey name, boolean value) { - setString(name.getPropertyKey(), String.valueOf(value)); - } - - @Override - public Integer getInt(String name) { - checkAndLoad(); - return config.getInt(name); - } - - @Override - public Integer getInt(ConfigKey name) { - checkAndLoad(); - return config.getInt(name); - } - - @Override - public Integer getInt(String name, int defaultValue) { - checkAndLoad(); - return config.getInt(name, defaultValue); - } - - @Override - public void setInt(String name, int value) { - setString(name, String.valueOf(value)); - } - - @Override - public void setInt(ConfigKey name, int value) { - setString(name.getPropertyKey(), String.valueOf(value)); - } - - @Override - public Long getLong(String name) { - checkAndLoad(); - return config.getLong(name); - } - - @Override - public Long getLong(ConfigKey name) { - checkAndLoad(); - return config.getLong(name); - } - - @Override - public Long getLong(String name, long defaultValue) { - checkAndLoad(); - return config.getLong(name, defaultValue); - } - - @Override - public void setLong(String name, long value) { - setString(name, String.valueOf(value)); - } - - @Override - public void setLong(ConfigKey name, long value) { - setString(name.getPropertyKey(), String.valueOf(value)); - } - - @Override - public Float getFloat(String name) { - checkAndLoad(); - return config.getFloat(name); - } - - @Override - public Float getFloat(ConfigKey name) { - checkAndLoad(); - return config.getFloat(name); - } - - @Override - public Float getFloat(String name, float defaultValue) { - checkAndLoad(); - return config.getFloat(name, defaultValue); - } - - @Override - public void setFloat(String name, float value) { - setString(name, String.valueOf(value)); - } - - @Override - public void setFloat(ConfigKey name, float value) { - setString(name.getPropertyKey(), String.valueOf(value)); - } - - @Override - public List getList(String name) { - checkAndLoad(); - return config.getList(name); - } - - @Override - public List getList(String name, String[] defaultValue) { - checkAndLoad(); - return config.getList(name, defaultValue); - } - - @Override - public List getList(ConfigKey name) { - checkAndLoad(); - return config.getList(name); - } - - @Override - public Config getConfig(String name) { - checkAndLoad(); - return config.getConfig(name); - } - - @Override - public Config getConfig(ConfigKey name) { - checkAndLoad(); - return config.getConfig(name); - } - - @Override - public Class getClass(String name) throws ClassNotFoundException { - checkAndLoad(); - return config.getClass(name); - } - - @Override - public Class getClass(String name, Class defaultValue) throws ClassNotFoundException { - checkAndLoad(); - return config.getClass(name, defaultValue); - } - - @Override - public Class getClass(ConfigKey name) throws ClassNotFoundException { - checkAndLoad(); - return config.getClass(name); - } - - @Override - public T getInstance(String name) throws ClassNotFoundException { - checkAndLoad(); - return config.getInstance(name); - } - - @Override - public T getInstance(ConfigKey name) throws ClassNotFoundException { - checkAndLoad(); - return config.getInstance(name); - } - - @Override - public T getInstance(String name, Class xface) throws ClassNotFoundException { - checkAndLoad(); - return config.getInstance(name, xface); - } -} \ No newline at end of file