GeneralSubtree.java revision f33eae7e84eb6d3b0f4e86b59605bb3de73009f3
1adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/* 2adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 3adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 4adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this work for additional information regarding copyright ownership. 5adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 6adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (the "License"); you may not use this file except in compliance with 7adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the License. You may obtain a copy of the License at 8adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 9adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 10adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 11adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Unless required by applicable law or agreed to in writing, software 12adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 13adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * See the License for the specific language governing permissions and 15adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * limitations under the License. 16adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 17adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 18adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 19adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project* @author Vladimir N. Molotkov, Alexander Y. Kleymenov 20adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project* @version $Revision$ 21adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project*/ 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 23adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpackage org.apache.harmony.security.x509; 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport org.apache.harmony.security.asn1.ASN1Implicit; 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport org.apache.harmony.security.asn1.ASN1Integer; 27adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport org.apache.harmony.security.asn1.ASN1Sequence; 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport org.apache.harmony.security.asn1.ASN1Type; 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport org.apache.harmony.security.asn1.BerInputStream; 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 32f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * The class encapsulates the ASN.1 DER encoding/decoding work 33adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * with the GeneralSubtree structure which is a part of X.509 certificate: 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (as specified in RFC 3280 - 35adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Internet X.509 Public Key Infrastructure. 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Certificate and Certificate Revocation List (CRL) Profile. 37adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.ietf.org/rfc/rfc3280.txt): 38f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <pre> 40f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 41adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * GeneralSubtree ::= SEQUENCE { 42adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * base GeneralName, 43adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * minimum [0] BaseDistance DEFAULT 0, 44adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * maximum [1] BaseDistance OPTIONAL } 45f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * BaseDistance ::= INTEGER (0..MAX) 47f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 48adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * </pre> 49f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 50adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see org.apache.harmony.security.x509.NameConstraints 51adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see org.apache.harmony.security.x509.GeneralName 52adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 53adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic class GeneralSubtree { 54adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 55adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // the value of base field of the structure 56adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final GeneralName base; 57adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // the value of minimum field of the structure 58adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final int minimum; 59adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // the value of maximum field of the structure 60adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final int maximum; 61adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // the ASN.1 encoded form of GeneralSubtree 62adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private byte[] encoding; 63adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 64adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 65adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * TODO 66adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param base: GeneralName 67adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 68adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public GeneralSubtree(GeneralName base) { 69adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this(base, 0, -1); 70adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 71f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes 72adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 73adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * TODO 74adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param base: GeneralName 75adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param minimum: int 76adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 77adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public GeneralSubtree(GeneralName base, int minimum) { 78adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this(base, minimum, -1); 79adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 80f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes 81adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 82adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * TODO 83adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param base: GeneralName 84adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param minimum: int 85adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param maximum: int 86adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 87adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public GeneralSubtree(GeneralName base, int minimum, int maximum) { 88adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.base = base; 89adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.minimum = minimum; 90adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.maximum = maximum; 91adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 92f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes 93adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 94adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the value of base field of the structure. 95adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return base 96adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 97adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public GeneralName getBase() { 98adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return base; 99adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 100adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 101adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 102adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the value of maximum field of the structure. 103adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return maximum 104adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 105adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public int getMaximum() { 106adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return maximum; 107adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 108adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 109adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 110adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the value of minimum field of the structure. 111adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return minimum 112adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 113adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public int getMinimum() { 114adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return minimum; 115adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 116adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 117adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 118adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns ASN.1 encoded form of this X.509 GeneralSubtree value. 119adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a byte array containing ASN.1 encode form. 120adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 121adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public byte[] getEncoded() { 122adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (encoding == null) { 123adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project encoding = ASN1.encode(this); 124adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 125adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return encoding; 126adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 127adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 128adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 129adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Places the string representation of extension value 130adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * into the StringBuffer object. 131adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 132adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public void dumpValue(StringBuffer buffer, String prefix) { 133f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes buffer.append(prefix).append("General Subtree: [\n"); 134f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes buffer.append(prefix).append(" base: ").append(base).append('\n'); 135f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes buffer.append(prefix).append(" minimum: ") 136adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .append(minimum).append('\n'); 137adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (maximum >= 0) { 138f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes buffer.append(prefix).append(" maximum: ") 139adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .append(maximum).append('\n'); 140adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 141f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes buffer.append(prefix).append("]\n"); 142adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 143adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 144adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 145adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * ASN.1 DER X.509 GeneralSubtree encoder/decoder class. 146adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 147adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static final ASN1Sequence ASN1 = new ASN1Sequence(new ASN1Type[] { 148adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project GeneralName.ASN1, 149f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes new ASN1Implicit(0, ASN1Integer.getInstance()), 150adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project new ASN1Implicit(1, ASN1Integer.getInstance()) }) { 151adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project { 152adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project setDefault(new byte[] {0}, 1); // minimum 0 153adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project setOptional(2); // maximum optional 154adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 155adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 156adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected Object getDecodedObject(BerInputStream in) { 157adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Object[] values = (Object[]) in.content; 158adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project int maximum = -1; // is optional maximum missing? 159adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (values[2] != null) { 160adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project maximum = ASN1Integer.toIntValue(values[2]); // no! 161adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 162adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return new GeneralSubtree((GeneralName) values[0], 163adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project ASN1Integer.toIntValue(values[1]), 164adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project maximum); 165adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 166adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 167adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected void getValues(Object object, Object[] values) { 168adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 169adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project GeneralSubtree gs = (GeneralSubtree) object; 170adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 171adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project values[0] = gs.base; 172adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project values[1] = ASN1Integer.fromIntValue(gs.minimum); 173adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (gs.maximum > -1) { 174adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project values[2] = ASN1Integer.fromIntValue(gs.maximum); 175adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 176adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 177adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project }; 178adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project} 179