- java.lang.Object
-
- org.snmp4j.asn1.BER
-
public class BER extends java.lang.ObjectThe BER class provides utility methods for the BER encoding and decoding.- Version:
- 2.5.8
- Author:
- Frank Fock, Jochen Katz
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBER.MutableByteTheMutableByteclass serves for exchanging type information from the various decode* methods.
-
Field Summary
Fields Modifier and Type Field Description static byteASN_APPLICATIONstatic byteASN_BIT_STRstatic byteASN_BIT8static byteASN_BOOLEANstatic byteASN_CONSTRUCTORstatic byteASN_CONTEXTstatic byteASN_EXTENSION_IDstatic byteASN_INTEGERstatic byteASN_LONG_LENstatic byteASN_NULLstatic byteASN_OBJECT_IDstatic byteASN_OCTET_STRstatic byteASN_PRIMITIVEstatic byteASN_PRIVATEstatic byteASN_SEQUENCEstatic byteASN_SETstatic byteASN_UNIVERSALstatic byteBITSTRINGstatic byteCOUNTERstatic byteCOUNTER32static byteCOUNTER64static intENDOFMIBVIEWstatic byteGAUGEstatic byteGAUGE32static byteINTEGERstatic byteINTEGER32static byteIPADDRESSstatic intMAX_OID_LENGTHstatic intNOSUCHINSTANCEstatic intNOSUCHOBJECTstatic byteNULLstatic byteOCTETSTRINGstatic byteOIDstatic byteOPAQUEstatic byteSEQUENCEstatic byteTIMETICKS
-
Constructor Summary
Constructors Constructor Description BER()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static voidcheckSequenceLength(int expectedLength, int actualLength, BERSerializable sequence)Checks the length of a sequence, by computing the expected payload length and comparing it with the actual length as given.static voidcheckSequenceLength(int expectedLength, BERSerializable sequence)Deprecated.UsecheckSequenceLength(int, int, BERSerializable)because it is immune against longer than minimum numeric value encodings.static java.math.BigIntegerdecodeBigInteger(BERInputStream is, BER.MutableByte type)static intdecodeHeader(BERInputStream is, BER.MutableByte type)Decodes an ASN.1 header for an object with the ID and length specified.static intdecodeHeader(BERInputStream is, BER.MutableByte type, boolean checkLength)Decodes an ASN.1 header for an object with the ID and length specified.static intdecodeInteger(BERInputStream is, BER.MutableByte type)static intdecodeLength(BERInputStream is)Decodes a ASN.1 length.static intdecodeLength(BERInputStream is, boolean checkLength)Decodes a ASN.1 length.static voiddecodeNull(BERInputStream is, BER.MutableByte type)static int[]decodeOID(BERInputStream is, BER.MutableByte type)static byte[]decodeString(BERInputStream is, BER.MutableByte type)static longdecodeUnsignedInt64(BERInputStream is, BER.MutableByte type)static longdecodeUnsignedInteger(BERInputStream is, BER.MutableByte type)static voidencodeBigInteger(java.io.OutputStream os, byte type, java.math.BigInteger value)Encode a signed integer.static voidencodeHeader(java.io.OutputStream os, int type, int length)Encodes an ASN.1 header for an object with the ID and length specified.static voidencodeHeader(java.io.OutputStream os, int type, int length, int numBytesLength)Encodes an ASN.1 header for an object with the ID and length specified with a fixed length of the encoded length as supplied.static voidencodeInteger(java.io.OutputStream os, byte type, int value)Encode a signed integer.static voidencodeLength(java.io.OutputStream os, int length)Encodes the length of an ASN.1 object.static voidencodeLength(java.io.OutputStream os, int length, int numLengthBytes)Encodes the length of an ASN.1 object.static voidencodeOID(java.io.OutputStream os, byte type, int[] oid)Encode an ASN.1 oid filled with the supplied oid value.static voidencodeSequence(java.io.OutputStream os, byte type, int length)Encode an ASN.1 header for a sequence with the ID and length specified.static voidencodeString(java.io.OutputStream os, byte type, byte[] string)Encode an ASN.1 octet string filled with the supplied input string.static voidencodeSubID(java.io.OutputStream os, int subID)static voidencodeUnsignedInt64(java.io.OutputStream os, byte type, long value)static voidencodeUnsignedInteger(java.io.OutputStream os, byte type, long value)Encode an unsigned integer.static intgetBERLengthOfLength(int length)Compute the space needed to encode the length.static intgetBigIntegerBERLength(java.math.BigInteger value)Get the BER encoded length of a BigInteger value.static intgetOIDLength(int[] value)Gets the payload length in bytes of the BER encoded OID value.static java.lang.StringgetPositionMessage(BERInputStream is)static intgetSubIDLength(int subID)static booleanisCheckFirstSubID012()static booleanisCheckSequenceLength()Gets the SEQUENCE length checking mode.booleanisCheckValueLength()static voidsetCheckFirstSubID012(boolean checkFirstSubID012)static voidsetCheckSequenceLength(boolean checkSequenceLen)Sets the application wide SEQUENCE length checking mode.voidsetCheckValueLength(boolean checkValueLength)
-
-
-
Field Detail
-
ASN_BOOLEAN
public static final byte ASN_BOOLEAN
- See Also:
- Constant Field Values
-
ASN_INTEGER
public static final byte ASN_INTEGER
- See Also:
- Constant Field Values
-
ASN_BIT_STR
public static final byte ASN_BIT_STR
- See Also:
- Constant Field Values
-
ASN_OCTET_STR
public static final byte ASN_OCTET_STR
- See Also:
- Constant Field Values
-
ASN_NULL
public static final byte ASN_NULL
- See Also:
- Constant Field Values
-
ASN_OBJECT_ID
public static final byte ASN_OBJECT_ID
- See Also:
- Constant Field Values
-
ASN_SEQUENCE
public static final byte ASN_SEQUENCE
- See Also:
- Constant Field Values
-
ASN_SET
public static final byte ASN_SET
- See Also:
- Constant Field Values
-
ASN_UNIVERSAL
public static final byte ASN_UNIVERSAL
- See Also:
- Constant Field Values
-
ASN_APPLICATION
public static final byte ASN_APPLICATION
- See Also:
- Constant Field Values
-
ASN_CONTEXT
public static final byte ASN_CONTEXT
- See Also:
- Constant Field Values
-
ASN_PRIVATE
public static final byte ASN_PRIVATE
- See Also:
- Constant Field Values
-
ASN_PRIMITIVE
public static final byte ASN_PRIMITIVE
- See Also:
- Constant Field Values
-
ASN_CONSTRUCTOR
public static final byte ASN_CONSTRUCTOR
- See Also:
- Constant Field Values
-
ASN_LONG_LEN
public static final byte ASN_LONG_LEN
- See Also:
- Constant Field Values
-
ASN_EXTENSION_ID
public static final byte ASN_EXTENSION_ID
- See Also:
- Constant Field Values
-
ASN_BIT8
public static final byte ASN_BIT8
- See Also:
- Constant Field Values
-
INTEGER
public static final byte INTEGER
- See Also:
- Constant Field Values
-
INTEGER32
public static final byte INTEGER32
- See Also:
- Constant Field Values
-
BITSTRING
public static final byte BITSTRING
- See Also:
- Constant Field Values
-
OCTETSTRING
public static final byte OCTETSTRING
- See Also:
- Constant Field Values
-
NULL
public static final byte NULL
- See Also:
- Constant Field Values
-
OID
public static final byte OID
- See Also:
- Constant Field Values
-
SEQUENCE
public static final byte SEQUENCE
- See Also:
- Constant Field Values
-
IPADDRESS
public static final byte IPADDRESS
- See Also:
- Constant Field Values
-
COUNTER
public static final byte COUNTER
- See Also:
- Constant Field Values
-
COUNTER32
public static final byte COUNTER32
- See Also:
- Constant Field Values
-
GAUGE
public static final byte GAUGE
- See Also:
- Constant Field Values
-
GAUGE32
public static final byte GAUGE32
- See Also:
- Constant Field Values
-
TIMETICKS
public static final byte TIMETICKS
- See Also:
- Constant Field Values
-
OPAQUE
public static final byte OPAQUE
- See Also:
- Constant Field Values
-
COUNTER64
public static final byte COUNTER64
- See Also:
- Constant Field Values
-
NOSUCHOBJECT
public static final int NOSUCHOBJECT
- See Also:
- Constant Field Values
-
NOSUCHINSTANCE
public static final int NOSUCHINSTANCE
- See Also:
- Constant Field Values
-
ENDOFMIBVIEW
public static final int ENDOFMIBVIEW
- See Also:
- Constant Field Values
-
MAX_OID_LENGTH
public static final int MAX_OID_LENGTH
- See Also:
- Constant Field Values
-
-
Method Detail
-
encodeHeader
public static void encodeHeader(java.io.OutputStream os, int type, int length) throws java.io.IOExceptionEncodes an ASN.1 header for an object with the ID and length specified.- Parameters:
os- anOutputStreamto which the header is encoded.type- the type of the ASN.1 object. Must be < 30, i.e. no extension octets.length- the length of the object. The maximum length is 0xFFFFFFFF;- Throws:
java.io.IOException- if the output stream fails to store the encoded header.
-
encodeHeader
public static void encodeHeader(java.io.OutputStream os, int type, int length, int numBytesLength) throws java.io.IOExceptionEncodes an ASN.1 header for an object with the ID and length specified with a fixed length of the encoded length as supplied.- Parameters:
os- anOutputStreamto which the header is encoded.type- the type of the ASN.1 object. Must be < 30, i.e. no extension octets.length- the length of the object. The maximum length is 0xFFFFFFFF;numBytesLength- the number of bytes used to encode the length of the length.- Throws:
java.io.IOException- if the output stream fails to store the encoded header.
-
getBERLengthOfLength
public static int getBERLengthOfLength(int length)
Compute the space needed to encode the length.- Parameters:
length- Length to encode- Returns:
- the count of bytes needed to encode the value
length
-
encodeLength
public static void encodeLength(java.io.OutputStream os, int length) throws java.io.IOExceptionEncodes the length of an ASN.1 object.- Parameters:
os- anOutputStreamto which the length is encoded.length- the length of the object. The maximum length is 0xFFFFFFFF;- Throws:
java.io.IOException- if the output stream fails to store the encoded length.
-
encodeLength
public static void encodeLength(java.io.OutputStream os, int length, int numLengthBytes) throws java.io.IOExceptionEncodes the length of an ASN.1 object.- Parameters:
os- anOutputStreamto which the length is encoded.length- the length of the object. The maximum length is 0xFFFFFFFF;numLengthBytes- the number of bytes to be used to encode the length using the long form.- Throws:
java.io.IOException- if the output stream fails to store the encoded length.
-
encodeInteger
public static void encodeInteger(java.io.OutputStream os, byte type, int value) throws java.io.IOExceptionEncode a signed integer.- Parameters:
os- anOutputStreamto which the length is encoded.type- the tag type for the integer (typically 0x02)value- the integer value to encode.- Throws:
java.io.IOException- if the output stream fails to store the encoded integer.
-
encodeBigInteger
public static void encodeBigInteger(java.io.OutputStream os, byte type, java.math.BigInteger value) throws java.io.IOExceptionEncode a signed integer.- Parameters:
os- anOutputStreamto which the length is encoded.type- the tag type for the integer (typically 0x02)value- the integer value to encode.- Throws:
java.io.IOException- if the output stream fails to store the encoded integer.
-
getBigIntegerBERLength
public static int getBigIntegerBERLength(java.math.BigInteger value)
Get the BER encoded length of a BigInteger value.- Parameters:
value- a BigInteger value with a length that is less 2^31.- Returns:
- the length of the BER encoding of the supplied BigInteger as INTEGER value.
-
encodeUnsignedInteger
public static void encodeUnsignedInteger(java.io.OutputStream os, byte type, long value) throws java.io.IOExceptionEncode an unsigned integer. ASN.1 integer ::= 0x02 asnlength byte {byte}*- Parameters:
os- anOutputStreamto which the length is encoded.type- the tag type for the integer (typically 0x02)value- the integer value to encode.- Throws:
java.io.IOException- if the output stream fails to store the encoded value.
-
encodeString
public static void encodeString(java.io.OutputStream os, byte type, byte[] string) throws java.io.IOExceptionEncode an ASN.1 octet string filled with the supplied input string.- Parameters:
os- anOutputStreamto which the length is encoded.type- the tag type for the integer (typically 0x02)string- thebytearray containing the octet string value.- Throws:
java.io.IOException- if the output stream fails to store the encoded value.
-
encodeSequence
public static void encodeSequence(java.io.OutputStream os, byte type, int length) throws java.io.IOExceptionEncode 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;- Parameters:
os- anOutputStreamto which the length is encoded.type- the tag type for the integer (typically 0x02)length- the length of the sequence to encode.- Throws:
java.io.IOException- if the output stream fails to store the encoded value.
-
getOIDLength
public static int getOIDLength(int[] value)
Gets the payload length in bytes of the BER encoded OID value.- Parameters:
value- an array of unsigned integer values representing an object identifier.- Returns:
- the BER encoded length of the OID without header and length.
-
getSubIDLength
public static int getSubIDLength(int subID)
-
encodeOID
public static void encodeOID(java.io.OutputStream os, byte type, int[] oid) throws java.io.IOExceptionEncode an ASN.1 oid filled with the supplied oid value.- Parameters:
os- anOutputStreamto which the length is encoded.type- the tag type for the integer (typically 0x06)oid- theintarray containing the OID value.- Throws:
java.io.IOException- if the output stream fails to store the encoded value.
-
encodeSubID
public static void encodeSubID(java.io.OutputStream os, int subID) throws java.io.IOException- Throws:
java.io.IOException
-
encodeUnsignedInt64
public static void encodeUnsignedInt64(java.io.OutputStream os, byte type, long value) throws java.io.IOException- Throws:
java.io.IOException
-
decodeLength
public static int decodeLength(BERInputStream is) throws java.io.IOException
Decodes a ASN.1 length.- Parameters:
is- anInputStream- Returns:
- the decoded length.
- Throws:
java.io.IOException- if the input stream contains an invalid BER encoding or an IO exception occurred while reading from the stream.
-
decodeLength
public static int decodeLength(BERInputStream is, boolean checkLength) throws java.io.IOException
Decodes a ASN.1 length.- Parameters:
is- anInputStreamcheckLength- iffalselength check is always suppressed.- Returns:
- the decoded length.
- Throws:
java.io.IOException- if the input stream contains an invalid BER encoding or an IO exception occurred while reading from the stream.
-
decodeHeader
public static int decodeHeader(BERInputStream is, BER.MutableByte type, boolean checkLength) throws java.io.IOException
Decodes an ASN.1 header for an object with the ID and length specified. On entry, datalength is input as the number of valid bytes following "data". On exit, it is returned as the number of valid bytes in this object following the id and length. This only works on data types < 30, i.e. no extension octets. The maximum length is 0xFFFF;- Parameters:
is- the BERInputStream to decode.type- returns the type of the object at the current position in the input stream.checkLength- iffalselength check is always suppressed.- Returns:
- the decoded length of the object.
- Throws:
java.io.IOException- if the input stream contains an invalid BER encoding or an IO exception occurred while reading from the stream.
-
decodeHeader
public static int decodeHeader(BERInputStream is, BER.MutableByte type) throws java.io.IOException
Decodes an ASN.1 header for an object with the ID and length specified. On entry, datalength is input as the number of valid bytes following "data". On exit, it is returned as the number of valid bytes in this object following the id and length. This only works on data types < 30, i.e. no extension octets. The maximum length is 0xFFFF;- Parameters:
is- the BERInputStream to decode.type- returns the type of the object at the current position in the input stream.- Returns:
- the decoded length of the object.
- Throws:
java.io.IOException- if the input stream contains an invalid BER encoding or an IO exception occurred while reading from the stream.
-
decodeInteger
public static int decodeInteger(BERInputStream is, BER.MutableByte type) throws java.io.IOException
- Throws:
java.io.IOException
-
decodeBigInteger
public static java.math.BigInteger decodeBigInteger(BERInputStream is, BER.MutableByte type) throws java.io.IOException
- Throws:
java.io.IOException
-
getPositionMessage
public static java.lang.String getPositionMessage(BERInputStream is)
-
decodeUnsignedInteger
public static long decodeUnsignedInteger(BERInputStream is, BER.MutableByte type) throws java.io.IOException
- Throws:
java.io.IOException
-
decodeString
public static byte[] decodeString(BERInputStream is, BER.MutableByte type) throws java.io.IOException
- Throws:
java.io.IOException
-
decodeOID
public static int[] decodeOID(BERInputStream is, BER.MutableByte type) throws java.io.IOException
- Throws:
java.io.IOException
-
decodeNull
public static void decodeNull(BERInputStream is, BER.MutableByte type) throws java.io.IOException
- Throws:
java.io.IOException
-
decodeUnsignedInt64
public static long decodeUnsignedInt64(BERInputStream is, BER.MutableByte type) throws java.io.IOException
- Throws:
java.io.IOException
-
isCheckSequenceLength
public static boolean isCheckSequenceLength()
Gets the SEQUENCE length checking mode.- Returns:
trueif the length of a parsed SEQUENCE should be checked against the real length of the objects parsed.
-
setCheckSequenceLength
public static void setCheckSequenceLength(boolean checkSequenceLen)
Sets the application wide SEQUENCE length checking mode.- Parameters:
checkSequenceLen- specifies whether he length of a parsed SEQUENCE should be checked against the real length of the objects parsed.
-
checkSequenceLength
public static void checkSequenceLength(int expectedLength, BERSerializable sequence) throws java.io.IOExceptionDeprecated.UsecheckSequenceLength(int, int, BERSerializable)because it is immune against longer than minimum numeric value encodings.Checks the length of a sequence, by computing the expected payload length and comparing it with the expected length as given in the header of the BER sequence. IfisCheckSequenceLength()and the length differ anIOExceptionis thrown.- Parameters:
expectedLength- the expected length as encoded in the header of the BER sequence to check.sequence- the BER sequence to validate.- Throws:
java.io.IOException- is thrown ifisCheckSequenceLength()and the length differ.
-
checkSequenceLength
public static void checkSequenceLength(int expectedLength, int actualLength, BERSerializable sequence) throws java.io.IOExceptionChecks the length of a sequence, by computing the expected payload length and comparing it with the actual length as given. IfisCheckSequenceLength()and the length differ anIOExceptionis thrown.- Parameters:
expectedLength- the expected length as encoded in the header of the BER sequence to check.actualLength- the number of bytes actually decoded from the BER stream for this sequence.sequence- the BER sequence to validate.- Throws:
java.io.IOException- is thrown ifisCheckSequenceLength()and the length differ.
-
isCheckValueLength
public boolean isCheckValueLength()
-
setCheckValueLength
public void setCheckValueLength(boolean checkValueLength)
-
isCheckFirstSubID012
public static boolean isCheckFirstSubID012()
-
setCheckFirstSubID012
public static void setCheckFirstSubID012(boolean checkFirstSubID012)
-
-