org.wildfly.security.asn1.ASN1Encoder Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source.
* Copyright 2014 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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.wildfly.security.asn1;
import java.io.Flushable;
import java.math.BigInteger;
import java.time.ZonedDateTime;
import java.util.BitSet;
import java.util.EnumSet;
/**
* An interface for encoding ASN.1 values.
*
* @author Farah Juma
*/
public interface ASN1Encoder extends Flushable {
/**
* Start encoding an ASN.1 sequence. All subsequent encode operations will be part of
* this sequence until {@link #endSequence()} is called.
*/
void startSequence();
/**
* Finish encoding an ASN.1 sequence.
*
* @throws IllegalStateException if there is no sequence to end
*/
void endSequence() throws IllegalStateException;
/**
* Start encoding an ASN.1 set. All subsequent encode operations will be part of this
* set until {@link #endSet()} is called.
*/
void startSet();
/**
* Finish encoding an ASN.1 set.
*
* @throws IllegalStateException if there is no set to end
*/
void endSet() throws IllegalStateException;
/**
* Start encoding an ASN.1 "set of" element. All subsequent encode operations will be
* part of this set until {@link #endSetOf()} is called.
*/
void startSetOf();
/**
* Finish encoding an ASN.1 "set of" element.
*
* @throws IllegalStateException if there is no set to end
*/
void endSetOf() throws IllegalStateException;
/**
* Start encoding an ASN.1 explicitly tagged element. All subsequent encode operations
* will be part of this explicitly tagged element until {@link #endExplicit()} is called.
*
* @param number the tag number for the explicit, context-specific tag
*/
void startExplicit(int number);
/**
* Start encoding an ASN.1 explicitly tagged element. All subsequent encode operations
* will be part of this explicitly tagged element until {@link #endExplicit()} is called.
*
* @param clazz the class for the explicit tag
* @param number the tag number for the explicit tag
*/
void startExplicit(int clazz, int number);
/**
* Finish encoding an ASN.1 explicitly tagged element.
*
* @throws IllegalStateException if there is no explicitly tagged element to end
*/
void endExplicit() throws IllegalStateException;
/**
* Encode an ASN.1 octet string value.
*
* @param str the octet string to encode
*/
void encodeOctetString(String str);
/**
* Encode an ASN.1 octet string value.
*
* @param str the byte array containing the octet string to encode
*/
void encodeOctetString(byte[] str);
/**
* Encode an ASN.1 IA5 string value.
*
* @param str the IA5 string to encode
*/
void encodeIA5String(String str);
/**
* Encode an ASN.1 IA5 string value.
*
* @param str the byte array containing IA5 string to encode
*/
void encodeIA5String(byte[] str);
/**
* Encode an ASN.1 printable string value.
*
* @param str the byte array containing the printable string to encode
*/
void encodePrintableString(byte[] str);
/**
* Encode an ASN.1 printable string value.
*
* @param str the printable string to encode
*/
void encodePrintableString(String str);
/**
* Encode an ASN.1 UTF8String string value.
*
* @param str the string to encode
*/
void encodeUTF8String(String str);
/**
* Encode an ASN.1 BMPString string value.
*
* @param str the string to encode
*/
void encodeBMPString(String str);
/**
* Encode an ASN.1 UniversalString string value.
*
* @param str the string to encode
*/
void encodeUniversalString(String str);
/**
* Encode an ASN.1 bit string value.
*
* @param str the byte array containing the bit string to encode (all bits in the bit string will be used)
*/
void encodeBitString(byte[] str);
/**
* Encode an ASN.1 bit string value.
*
* @param str the byte array containing the bit string to encode
* @param numUnusedBits the number of unused bits in the byte array
*/
void encodeBitString(byte[] str, int numUnusedBits);
/**
* Encode an enum set as an ASN.1 bit string, with each ordinal value of the set representing a single bit.
*
* @param enumSet the enum set (must not be {@code null})
*/
void encodeBitString(EnumSet enumSet);
/**
* Encode an ASN.1 bit string value.
*
* @param bitSet the bit set (must not be {@code null})
*/
void encodeBitString(BitSet bitSet);
/**
* Encode an ASN.1 bit string value.
*
* @param binaryStr the bit string to encode, as a binary string
*/
void encodeBitString(String binaryStr);
/**
* Encode an ASN.1 bit string where the value represents the binary form of the given integer.
*
* @param integer the integer to encode as a binary string
*/
void encodeBitString(BigInteger integer);
/**
* Encode an ASN.1 GeneralizedTime type.
*
* @param time the time to encode (must not be {@code null})
*/
void encodeGeneralizedTime(ZonedDateTime time);
/**
* Encode an ASN.1 object identifier value.
*
* @param objectIdentifier the object identifier to encode
* @throws ASN1Exception if the given object identifier is invalid
*/
void encodeObjectIdentifier(String objectIdentifier) throws ASN1Exception;
/**
* Encode an ASN.1 null value.
*/
void encodeNull();
/**
* Indicate that the next encode operation should encode an ASN.1 value using
* the given implicit, context-specific tag.
*
* @param number the tag number for the implicit, context-specific tag
*/
void encodeImplicit(int number);
/**
* Indicate that the next encode operation should encode an ASN.1 value using
* the given implicit tag.
*
* @param clazz the class for the implicit tag
* @param number the tag number for the implicit tag
*/
void encodeImplicit(int clazz, int number);
/**
* Encode an ASN.1 {@code boolean} value.
*
* @param value the boolean to encode
*/
void encodeBoolean(boolean value);
/**
* Encode an ASN.1 integer value.
*
* @param integer the integer to encode
*/
default void encodeInteger(int integer) {
encodeInteger(BigInteger.valueOf(integer));
}
/**
* Encode an ASN.1 integer value.
*
* @param integer the integer to encode
*/
void encodeInteger(BigInteger integer);
/**
* Write an already encoded ASN.1 value to the target destination.
*
* @param encoded the encoded ASN.1 value to write
*/
void writeEncoded(byte[] encoded);
/**
* Flush the encoder, writing any saved ASN.1 encoded values to the target destination.
* Any unfinished sequences or sets will be ended.
*/
void flush();
/**
* Get the ASN.1 encoded bytes.
*
* @return the ASN.1 encoded bytes
*/
byte[] getEncoded();
}