/*_############################################################################
  _## 
  _##  SNMP4J - BER.java  
  _## 
  _##  Copyright 2003-2007  Frank Fock and Jochen Katz (SNMP4J.org)
  _##  
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##  
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##  
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##  
  _##########################################################################*/





package org.snmp4j.asn1;

import java.io.OutputStream;
import java.io.IOException;

/**
 * The BER class provides utility methods for the BER encoding and decoding.
 *
 * @author Jochen Katz & Frank Fock
 * @version 1.7.4
 */
public class BER {

  public static final byte ASN_BOOLEAN = 0x01;
  public static final byte ASN_INTEGER = 0x02;
  public static final byte ASN_BIT_STR = 0x03;
  public static final byte ASN_OCTET_STR = 0x04;
  public static final byte ASN_NULL = 0x05;
  public static final byte ASN_OBJECT_ID = 0x06;
  public static final byte ASN_SEQUENCE = 0x10;
  public static final byte ASN_SET = 0x11;
  public static final byte ASN_UNIVERSAL = 0x00;
  public static final byte ASN_APPLICATION = 0x40;
  public static final byte ASN_CONTEXT = (byte)0x80;
  public static final byte ASN_PRIVATE = (byte)0xC0;
  public static final byte ASN_PRIMITIVE = (byte)0x00;
  public static final byte ASN_CONSTRUCTOR = (byte)0x20;

  public static final byte ASN_LONG_LEN = (byte)0x80;
  public static final byte ASN_EXTENSION_ID = (byte)0x1F;
  public static final byte ASN_BIT8 = (byte)0x80;

  public static final byte INTEGER = ASN_UNIVERSAL | 0x02;
  public static final byte INTEGER32 = ASN_UNIVERSAL | 0x02;
  public static final byte BITSTRING = ASN_UNIVERSAL | 0x03;
  public static final byte OCTETSTRING = ASN_UNIVERSAL | 0x04;
  public static final byte NULL = ASN_UNIVERSAL | 0x05;
  public static final byte OID = ASN_UNIVERSAL | 0x06;
  public static final byte SEQUENCE = ASN_CONSTRUCTOR | 0x10;

  public static final byte IPADDRESS = ASN_APPLICATION | 0x00;
  public static final byte COUNTER = ASN_APPLICATION | 0x01;
  public static final byte COUNTER32 = ASN_APPLICATION | 0x01;
  public static final byte GAUGE = ASN_APPLICATION | 0x02;
  public static final byte GAUGE32 = ASN_APPLICATION | 0x02;
  public static final byte TIMETICKS = ASN_APPLICATION | 0x03;
  public static final byte OPAQUE = ASN_APPLICATION | 0x04;
  public static final byte COUNTER64 = ASN_APPLICATION | 0x06;

  public static final int NOSUCHOBJECT = 0x80;
  public static final int NOSUCHINSTANCE = 0x81;
  public static final int ENDOFMIBVIEW = 0x82;

  private static final int LENMASK = 0x0ff;
  public static final int MAX_OID_LENGTH = 127;

  private static boolean checkSequenceLength = true;
  private static boolean checkValueLength = true;

  /**
   * The <code>MutableByte</code> class serves for exchanging type information
   * from the various decode* methods.
   *
   * @author Frank Fock
   * @version 1.0
   */
  public static class MutableByte {
    byte value = 0;

    public MutableByte() { }

    public MutableByte(byte value) {
      setValue(value);
    }

    public void setValue(byte value) {
      this.value = value;
    }

    public byte getValue() {
      return value;
    }
  }

  /**
   * Encodes an ASN.1 header for an object with the ID and
   * length specified.
   * @param os
   *    an <code>OutputStream</code> to which the header is encoded.
   * @param type
   *    the type of the ASN.1 object. Must be < 30, i.e. no extension octets.
   * @param length
   *    the length of the object. The maximum length is 0xFFFFFFFF;
   * @throws IOException
   */
  public static final void encodeHeader(OutputStream os, int type, int length)
      throws IOException
  {
    os.write(type);
    encodeLength(os, length);
  }

  /**
   * Encodes an ASN.1 header for an object with the ID and
   * length specified with a fixed length of the encoded length as supplied.
   * @param os
   *    an <code>OutputStream</code> to which the header is encoded.
   * @param type
   *    the type of the ASN.1 object. Must be < 30, i.e. no extension octets.
   * @param length
   *    the length of the object. The maximum length is 0xFFFFFFFF;
   * @param numBytesLength
   *    the number of bytes used to encode the length of the length.
   * @throws IOException
   */
  public static final void encodeHeader(OutputStream os, int type, int length,
                                        int numBytesLength)
      throws IOException
  {
    os.write(type);
    encodeLength(os, length, numBytesLength);
  }

  /**
   * Compute the space needed to encode the length.
   *
   * @param length
   *    Length to encode
   * @return
   *    the count of bytes needed to encode the value <code>length</code>
   */
  public static final int getBERLengthOfLength(int length) {
    if (length < 0) {
      return 5;
    }
    else if (length < 0x80){
      return 1;
    }
    else if (length <= 0xFF){
      return 2;
    }
    else if (length <= 0xFFFF) { /* 0xFF < length <= 0xFFFF */
      return 3;
    }
    else if (length <= 0xFFFFFF) { /* 0xFFFF < length <= 0xFFFFFF */
      return 4;
    }
    return 5;
  }

  /**
   * Encodes the length of an ASN.1 object.
   * @param os
   *   an <code>OutputStream</code> to which the length is encoded.
   * @param length
   *    the length of the object. The maximum length is 0xFFFFFFFF;
   * @throws IOException
   */
  public static final void encodeLength(OutputStream os, int length)
      throws IOException
  {
    if (length < 0) {
      os.write(0x04 | ASN_LONG_LEN);
      os.write((length >> 24) & 0xFF);
      os.write((length >> 16) & 0xFF);
      os.write((length >> 8) & 0xFF);
      os.write(length & 0xFF);
    }
    else if (length < 0x80){
      os.write(length);
    }
    else if (length <= 0xFF){
      os.write((0x01 | ASN_LONG_LEN));
      os.write(length);
    }
    else if (length <= 0xFFFF) { /* 0xFF < length <= 0xFFFF */
      os.write(0x02 | ASN_LONG_LEN);
      os.write((length >> 8) & 0xFF);
      os.write(length & 0xFF);
    }
    else if (length <= 0xFFFFFF) { /* 0xFFFF < length <= 0xFFFFFF */
      os.write(0x03 | ASN_LONG_LEN);
      os.write((length >> 16) & 0xFF);
      os.write((length >> 8) & 0xFF);
      os.write(length & 0xFF);
    }
    else {
      os.write(0x04 | ASN_LONG_LEN);
      os.write((length >> 24) & 0xFF);
      os.write((length >> 16) & 0xFF);
      os.write((length >> 8) & 0xFF);
      os.write(length & 0xFF);
    }
  }

  /**
   * Encodes the length of an ASN.1 object.
   * @param os
   *   an <code>OutputStream</code> to which the length is encoded.
   * @param length
   *    the length of the object. The maximum length is 0xFFFFFFFF;
   * @param numLengthBytes
   *    the number of bytes to be used to encode the length using the long
   *    form.
   * @throws IOException
   */
  public static final void encodeLength(OutputStream os, int length,
                                        int numLengthBytes)
      throws IOException
  {
    os.write((numLengthBytes | ASN_LONG_LEN));
    for (int i=(numLengthBytes-1)*8; i>=0; i-=8) {
      os.write(((length >> i) & 0xFF));
    }
  }

  /**
   * Encode a signed integer.
   * @param os
   *    an <code>OutputStream</code> to which the length is encoded.
   * @param type
   *    the tag type for the integer (typically 0x02)
   * @param value
   *    the integer value to encode.
   * @throws IOException
   */
  public static final void encodeInteger(OutputStream os, byte type, int value)
      throws IOException
  {
    int integer = value;
    int mask;
    int intsize = 4;

    /*
     * Truncate "unnecessary" bytes off of the most significant end of this
     * 2's complement integer.  There should be no sequence of 9
     * consecutive 1's or 0's at the most significant end of the
     * integer.
     */
    mask = 0x1FF << ((8 * 3) - 1);
    /* mask is 0xFF800000 on a big-endian machine */
    while((((integer & mask) == 0) || ((integer & mask) == mask))
          && intsize > 1){
      intsize--;
      integer <<= 8;
    }
    encodeHeader(os, type, intsize);
    mask = 0xFF << (8 * 3);
    /* mask is 0xFF000000 on a big-endian machine */
    while ((intsize--) > 0){
      os.write(((integer & mask) >> (8 * 3)));
      integer <<= 8;
    }
  }

  /**
   * Encode an unsigned integer.
   * ASN.1 integer ::= 0x02 asnlength byte {byte}*
   * @param os
   *    an <code>OutputStream</code> to which the length is encoded.
   * @param type
   *    the tag type for the integer (typically 0x02)
   * @param value
   *    the integer value to encode.
   * @throws IOException
   */
  public static final void encodeUnsignedInteger(OutputStream os, byte type, long value)
      throws IOException
  {
    // figure out the len
    int len = 1;
    if ((( value >> 24) & LENMASK) != 0) {
      len = 4;
    }
    else if ((( value >> 16) & LENMASK) !=0) {
      len = 3;
    }
    else if ((( value >> 8) & LENMASK) !=0) {
      len = 2;
    }
    // check for 5 byte len where first byte will be
    // a null
    if ((( value >> (8 * (len -1))) & 0x080) !=0)	{
      len++;
    }

    // build up the header
    encodeHeader(os, type, len);  // length of BER encoded item

    // special case, add a null byte for len of 5
    if (len == 5) {
      os.write(0);
      for (int x=1; x<len; x++) {
        os.write((int) (value >> (8 * (4 - x) & LENMASK)));
      }
    }
    else
    {
      for (int x=0; x<len; x++) {
        os.write((int) (value >> (8 * ((len - 1) - x) & LENMASK)));
      }
    }
  }

  /**
   * Encode an ASN.1 octet string filled with the supplied input string.
   * @param os
   *    an <code>OutputStream</code> to which the length is encoded.
   * @param type
   *    the tag type for the integer (typically 0x02)
   * @param string
   *    the <code>byte</code> array containing the octet string value.
   * @throws IOException
   */
  public static final void encodeString(OutputStream os, byte type, byte[] string)
      throws IOException
  {
    /*
    * ASN.1 octet string ::= primstring | cmpdstring
    * primstring ::= 0x04 asnlength byte {byte}*
    * cmpdstring ::= 0x24 asnlength string {string}*
    * This code will never send a compound string.
    */
    encodeHeader(os, type, string.length);
    // fixed
    os.write(string);
  }

  /**
   * Encode an ASN.1 header for a sequence with the ID and length specified.
   * This only works on data types < 30, i.e. no extension octets.
   * The maximum length is 0xFFFF;
   *
   * @param os
   *    an <code>OutputStream</code> to which the length is encoded.
   * @param type
   *    the tag type for the integer (typically 0x02)
   * @param length
   *    the length of the sequence to encode.
   * @throws IOException
   */
  public static final void encodeSequence(OutputStream os, byte type, int length)
      throws IOException
  {
    os.write(type);
    encodeLength(os, length);
  }

  /**
   * Gets the payload length in bytes of the BER encoded OID value.
   * @param value
   *    an array of unsigned integer values representing an object identifier.
   * @return
   *    the BER encoded length of the OID without header and length.
   */
  public static final int getOIDLength(int[] value) {
    int length = 1; // for first 2 subids
    for (int i = 2; i < value.length; i++) {
      long v = value[i] & 0xFFFFFFFFL;
      if (v < 0x80) { //  7 bits long subid
        length += 1;
      }
      else if (v < 0x4000) {  // 14 bits long subid
        length += 2;
      }
      else if (v < 0x200000) { // 21 bits long subid
        length += 3;
      }
      else if (v < 0x10000000) { // 28 bits long subid
        length += 4;
      }
      else {                     // 32 bits long subid
        length += 5;
      }
    }
    return length;
  }

 /**
  * Encode an ASN.1 oid filled with the supplied oid value.
  *
  * @param os
  *    an <code>OutputStream</code> to which the length is encoded.
  * @param type
  *    the tag type for the integer (typically 0x06)
  * @param oid
  *    the <code>int</code> array containing the OID value.
  * @throws IOException
  */
  public static final void encodeOID(OutputStream os, byte type, int[] oid)
      throws IOException
  {
    /*
     * ASN.1 objid ::= 0x06 asnlength subidentifier {subidentifier}*
     * subidentifier ::= {leadingbyte}* lastbyte
     * leadingbyte ::= 1 7bitvalue
     * lastbyte ::= 0 7bitvalue
     */
    encodeHeader(os, type, getOIDLength(oid));

    int encodedLength = oid.length;
    int rpos = 0;

    if (oid.length < 2){
      os.write(0);
      encodedLength = 0;
    }
    else {
      os.write(((oid[1] + (oid[0] * 40)) & 0xFF));
      encodedLength -= 2;
      rpos = 2;
    }

    while (encodedLength-- > 0){
      long subid = (oid[rpos++] & 0xFFFFFFFFL);
      if (subid < 127) {
        os.write((int)subid & 0xFF);
      }
      else {
        long mask = 0x7F; /* handle subid == 0 case */
        long bits = 0;

        /* testmask *MUST* !!!! be of an unsigned type */
        for (long testmask = 0x7F, testbits = 0; testmask != 0;
             testmask <<= 7, testbits += 7) {
          if ((subid & testmask) > 0) {	/* if any bits set */
            mask = testmask;
            bits = testbits;
          }
        }
        /* mask can't be zero here */
        for (; mask != 0x7F; mask >>= 7, bits -= 7){
          /* fix a mask that got truncated above */
          if (mask == 0x1E00000) {
            mask = 0xFE00000;
          }
          os.write((int)(((subid & mask) >> bits) | ASN_BIT8));
        }
        os.write((int)(subid & mask));