path: root/luni/src/main/java/org/apache/harmony/security/x501/AttributeValue.java

/*
 *  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.
 */

/**
* @author Alexander V. Esin
* @version $Revision$
*/

package org.apache.harmony.security.x501;

import java.io.IOException;
import java.util.Collection;
import org.apache.harmony.security.asn1.ASN1SetOf;
import org.apache.harmony.security.asn1.ASN1StringType;
import org.apache.harmony.security.asn1.ASN1Type;
import org.apache.harmony.security.asn1.DerInputStream;
import org.apache.harmony.security.utils.ObjectIdentifier;

/**
 * X.501 Attribute Value
 */
public final class AttributeValue {

    public boolean wasEncoded;

    private boolean hasConsecutiveSpaces;

    public final String escapedString;

    private String rfc2253String;

    private String hexString;

    private final int tag;

    public byte[] encoded;

    public byte[] bytes; //FIXME remove??? bytes to be encoded

    public boolean hasQE; // raw string contains '"' or '\'

    public final String rawString;

    public AttributeValue(String parsedString, boolean hasQorE, ObjectIdentifier oid) {
        wasEncoded = false;

        this.hasQE = hasQorE;
        this.rawString = parsedString;
        this.escapedString = makeEscaped(rawString); // overwrites hasQE

        int tag;
        if (oid == AttributeTypeAndValue.EMAILADDRESS || oid == AttributeTypeAndValue.DC) {
            // http://www.rfc-editor.org/rfc/rfc5280.txt
            // says that EmailAddress and DomainComponent should be a IA5String
            tag = ASN1StringType.IA5STRING.id;
        } else if (isPrintableString(rawString)) {
            tag = ASN1StringType.PRINTABLESTRING.id;
        } else {
            tag = ASN1StringType.UTF8STRING.id;
        }
        this.tag = tag;
    }

    public AttributeValue(String hexString, byte[] encoded) {
        wasEncoded = true;

        this.hexString = hexString;
        this.encoded = encoded;

        try {
            DerInputStream in = new DerInputStream(encoded);

            tag = in.tag;

            if (DirectoryString.ASN1.checkTag(tag)) {
                // has string representation
                this.rawString = (String) DirectoryString.ASN1.decode(in);
                this.escapedString = makeEscaped(rawString);
            } else {
                this.rawString = hexString;
                this.escapedString = hexString;
            }
        } catch (IOException e) {
            IllegalArgumentException iae = new IllegalArgumentException(); //FIXME message
            iae.initCause(e);
            throw iae;
        }
    }

    public AttributeValue(String rawString, byte[] encoded, int tag) {
        wasEncoded = true;

        this.encoded = encoded;
        this.tag = tag;

        if (rawString == null) {
            this.rawString = getHexString();
            this.escapedString = hexString;
        } else {
            this.rawString = rawString;
            this.escapedString = makeEscaped(rawString);
        }
    }

    /**
     * Checks if the string is PrintableString (see X.680)
     */
    private static boolean isPrintableString(String str) {
        for (int i = 0; i< str.length(); ++i) {
            char ch = str.charAt(i);
            if (!(ch == 0x20
            || ch >= 0x27 && ch<= 0x29 // '()
            || ch >= 0x2B && ch<= 0x3A // +,-./0-9:
            || ch == '='
            || ch == '?'
            || ch >= 'A' && ch<= 'Z'
            || ch >= 'a' && ch<= 'z')) {
                return false;
            }
        }
        return true;
    }

    public int getTag() {
        return tag;
    }

    public String getHexString() {
        if (hexString == null) {
            if (!wasEncoded) {
                //FIXME optimize me: what about reusable OutputStream???
                if (tag == ASN1StringType.IA5STRING.id) {
                    encoded = ASN1StringType.IA5STRING.encode(rawString);
                } else if (tag == ASN1StringType.PRINTABLESTRING.id) {
                    encoded = ASN1StringType.PRINTABLESTRING.encode(rawString);
                } else {
                    encoded = ASN1StringType.UTF8STRING.encode(rawString);
                }
                wasEncoded = true;
            }

            StringBuilder buf = new StringBuilder(encoded.length * 2 + 1);
            buf.append('#');

            for (int i = 0, c; i < encoded.length; i++) {
                c = (encoded[i] >> 4) & 0x0F;
                if (c < 10) {
                    buf.append((char) (c + 48));
                } else {
                    buf.append((char) (c + 87));
                }

                c = encoded[i] & 0x0F;
                if (c < 10) {
                    buf.append((char) (c + 48));
                } else {
                    buf.append((char) (c + 87));
                }
            }
            hexString = buf.toString();
        }
        return hexString;
    }

    public Collection<?> getValues(ASN1Type type) throws IOException {
        return (Collection<?>) new ASN1SetOf(type).decode(encoded);
    }

    public void appendQEString(StringBuilder sb) {
        sb.append('"');
        if (hasQE) {
            char c;
            for (int i = 0; i < rawString.length(); i++) {
                c = rawString.charAt(i);
                if (c == '"' || c == '\\') {
                    sb.append('\\');
                }
                sb.append(c);
            }
        } else {
            sb.append(rawString);
        }
        sb.append('"');
    }

    /**
     * Escapes:
     * 1) chars ",", "+", """, "\", "<", ">", ";" (RFC 2253)
     * 2) chars "#", "=" (required by RFC 1779)
     * 3) leading or trailing spaces
     * 4) consecutive spaces (RFC 1779)
     * 5) according to the requirement to be RFC 1779 compatible:
     *    '#' char is escaped in any position
     */
    private String makeEscaped(String name) {
        int length = name.length();
        if (length == 0) {
            return name;
        }
        StringBuilder buf = new StringBuilder(length * 2);

        // Keeps track of whether we are escaping spaces.
        boolean escapeSpaces = false;

        for (int index = 0; index < length; index++) {
            char ch = name.charAt(index);
            switch (ch) {
            case ' ':
                /*
                 * We should escape spaces in the following cases:
                 *   1) at the beginning
                 *   2) at the end
                 *   3) consecutive spaces
                 * Since multiple spaces at the beginning or end will be covered by
                 * 3, we don't need a special case to check for that. Note that RFC 2253
                 * doesn't escape consecutive spaces, so they are removed in
                 * getRFC2253String instead of making two different strings here.
                 */
                if (index < (length - 1)) {
                    boolean nextIsSpace = name.charAt(index + 1) == ' ';
                    escapeSpaces = escapeSpaces || nextIsSpace || index == 0;
                    hasConsecutiveSpaces |= nextIsSpace;
                } else {
                    escapeSpaces = true;
                }

                if (escapeSpaces) {
                    buf.append('\\');
                }

                buf.append(' ');
                break;

            case '"':
            case '\\':
                hasQE = true;
                buf.append('\\');
                buf.append(ch);
                break;

            case ',':
            case '+':
            case '<':
            case '>':
            case ';':
            case '#': // required by RFC 1779
            case '=': // required by RFC 1779
                buf.append('\\');
                buf.append(ch);
                break;

            default:
                buf.append(ch);
                break;
            }

            if (escapeSpaces && ch != ' ') {
                escapeSpaces = false;
            }
        }

        return buf.toString();
    }

    public String makeCanonical() {
        int length = rawString.length();
        if (length == 0) {
            return rawString;
        }
        StringBuilder buf = new StringBuilder(length * 2);

        int index = 0;
        if (rawString.charAt(0) == '#') {
            buf.append('\\');
            buf.append('#');
            index++;
        }

        int bufLength;
        for (; index < length; index++) {
            char ch = rawString.charAt(index);

            switch (ch) {
            case ' ':
                bufLength = buf.length();
                if (bufLength == 0 || buf.charAt(bufLength - 1) == ' ') {
                    break;
                }
                buf.append(' ');
                break;

            case '"':
            case '\\':
            case ',':
            case '+':
            case '<':
            case '>':
            case ';':
                buf.append('\\');

            default:
                buf.append(ch);
            }
        }

        //remove trailing spaces
        for (bufLength = buf.length() - 1; bufLength > -1
                && buf.charAt(bufLength) == ' '; bufLength--) {
        }
        buf.setLength(bufLength + 1);

        return buf.toString();
    }

    /**
     * Removes escape sequences used in RFC1779 escaping but not in RFC2253 and
     * returns the RFC2253 string to the caller..
     */
    public String getRFC2253String() {
        if (!hasConsecutiveSpaces) {
            return escapedString;
        }

        if (rfc2253String == null) {
            // Scan backwards first since runs of spaces at the end are escaped.
            int lastIndex = escapedString.length() - 2;
            for (int i = lastIndex; i > 0; i -= 2) {
                if (escapedString.charAt(i) == '\\' && escapedString.charAt(i + 1) == ' ') {
                    lastIndex = i - 1;
                }
            }

            boolean beginning = true;
            StringBuilder sb = new StringBuilder(escapedString.length());
            for (int i = 0; i < escapedString.length(); i++) {
                char ch = escapedString.charAt(i);
                if (ch != '\\') {
                    sb.append(ch);
                    beginning = false;
                } else {
                    char nextCh = escapedString.charAt(i + 1);
                    if (nextCh == ' ') {
                        if (beginning || i > lastIndex) {
                            sb.append(ch);
                        }
                        sb.append(nextCh);
                    } else {
                        sb.append(ch);
                        sb.append(nextCh);
                        beginning = false;
                    }

                    i++;
                }
            }
            rfc2253String = sb.toString();
        }
        return rfc2253String;
    }
}