kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.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. 
 *  
 */
package org.apache.kerby.asn1;

import org.apache.kerby.asn1.type.AbstractAsn1Type;
import org.apache.kerby.asn1.type.Asn1Item;
import org.apache.kerby.asn1.type.Asn1Type;

import java.io.IOException;
import java.nio.ByteBuffer;

/**
 * Asn1 decoder. Given an input stream, it validates and parses
 * according to ASN1 spec, and the resultant object can be read
 * and read until exhausted.
 */
public class Asn1InputBuffer {
    private final LimitedByteBuffer limitedBuffer;

    /**
     * Constructor with bytes.
     * @param bytes The bytes
     */
    public Asn1InputBuffer(byte[] bytes) {
        this(new LimitedByteBuffer(bytes));
    }

    /**
     * Constructor with a ByteBuffer.
     * @param byteBuffer The byte buffer
     */
    public Asn1InputBuffer(ByteBuffer byteBuffer) {
        this(new LimitedByteBuffer(byteBuffer));
    }

    /**
     * Constructor with LimitedByteBuffer.
     * @param limitedByteBuffer The limited byte buffer
     */
    public Asn1InputBuffer(LimitedByteBuffer limitedByteBuffer) {
        this.limitedBuffer = limitedByteBuffer;
    }

    /**
     * Parse and read ASN1 object from the stream. If it's already
     * exhausted then null will be returned to indicate the end.
     * @return an ASN1 object if available otherwise null
     * @throws IOException e
     */
    public Asn1Type read() throws IOException {
        if (!limitedBuffer.available()) {
            return null;
        }
        Asn1Item one = AbstractAsn1Type.decodeOne(limitedBuffer);
        if (one.isSimple()) {
            one.decodeValueAsSimple();
        } else if (one.isCollection()) {
            one.decodeValueAsCollection();
        }
        if (one.isFullyDecoded()) {
            return one.getValue();
        }
        return one;
    }

    /**
     * Read from bytes.
     *
     * @param bytes The bytes
     * @throws IOException e
     */
    public void readBytes(byte[] bytes) throws IOException {
        limitedBuffer.readBytes(bytes);
    }

    public byte[] readAllLeftBytes() throws IOException {
        return limitedBuffer.readAllLeftBytes();
    }

    public void skipNext() throws IOException {
        if (limitedBuffer.available()) {
            AbstractAsn1Type.skipOne(limitedBuffer);
        }
    }

    public void skipBytes(int len) throws IOException {
        if (limitedBuffer.available()) {
            limitedBuffer.skip(len);
        }
    }
}