eu.europa.esig.dss.enumerations.KeyUsageBit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dss-enumerations Show documentation

DSS Enumerations contains all shared enumerations

There is a newer version: 6.1

/**
 * DSS - Digital Signature Services
 * Copyright (C) 2015 European Commission, provided under the CEF programme
 * 
 * This file is part of the "DSS - Digital Signature Services" project.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package eu.europa.esig.dss.enumerations;

/**
 * KeyUsage bit values
 *
 * KeyUsage ::= BIT STRING {
 * 		digitalSignature (0),
 * 		nonRepudiation (1),
 * 		keyEncipherment (2),
 * 		dataEncipherment (3),
 * 		keyAgreement (4),
 * 		keyCertSign (5),
 * 		cRLSign (6),
 * 		encipherOnly (7),
 * 		decipherOnly (8)
 * }
 */
public enum KeyUsageBit {

	/** digitalSignature */
	DIGITAL_SIGNATURE("digitalSignature",0, 128),

	/** nonRepudiation */
	NON_REPUDIATION("nonRepudiation",1, 64),

	/** keyEncipherment */
	KEY_ENCIPHERMENT("keyEncipherment",2, 32),

	/** dataEncipherment */
	DATA_ENCIPHERMENT("dataEncipherment",3, 16),

	/** keyAgreement */
	KEY_AGREEMENT("keyAgreement",4, 8),

	/** keyCertSign */
	KEY_CERT_SIGN("keyCertSign",5, 4),

	/** crlSign */
	CRL_SIGN("crlSign",6, 2),

	/** encipherOnly */
	ENCIPHER_ONLY("encipherOnly",7, 1),

	/** decipherOnly */
	DECIPHER_ONLY("decipherOnly",8, 32768);

	/** Name of the key usage */
	private final String value;

	/** The index */
	private final int index;

	/** The bit value */
	private final int bit;

	/**
	 * Default constructor
	 *
	 * @param value {@link String} name
	 * @param index bit value
	 */
	KeyUsageBit(String value, int index, int bit) {
		this.value = value;
		this.index = index;
		this.bit = bit;
	}

	/**
	 * Returns the key usage name
	 *
	 * @return {@link String}
	 */
	public String getValue() {
		return value;
	}

	/**
	 * Returns the key usage index
	 *
	 * @return key usage index
	 */
	public int getIndex() {
		return index;
	}
	
	/**
	 * Returns the key usage bit value
	 *
	 * @return key usage bit
	 */
	public int getBit() {
		return bit;
	}

}