org.xipki.security.KeyUsage Maven / Gradle / Ivy

Go to download
/*
 *
 * Copyright (c) 2013 - 2019 Lijun Liao
 *
 * 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.xipki.security;

import org.xipki.util.Args;

/**
 * Certificate key usage enum.
 *
 * @author Lijun Liao
 * @since 2.0.0
 */

public enum KeyUsage {

  digitalSignature(0,  org.bouncycastle.asn1.x509.KeyUsage.digitalSignature, "digitalSignature"),
  contentCommitment(1, org.bouncycastle.asn1.x509.KeyUsage.nonRepudiation,   "contentCommitment",
                                                                             "nonRepudiation"),
  keyEncipherment(2,   org.bouncycastle.asn1.x509.KeyUsage.keyEncipherment,  "keyEncipherment"),
  dataEncipherment(3,  org.bouncycastle.asn1.x509.KeyUsage.dataEncipherment, "dataEncipherment"),
  keyAgreement(4,      org.bouncycastle.asn1.x509.KeyUsage.keyAgreement,     "keyAgreement"),
  keyCertSign(5,       org.bouncycastle.asn1.x509.KeyUsage.keyCertSign,      "keyCertSign"),
  cRLSign(6,           org.bouncycastle.asn1.x509.KeyUsage.cRLSign,          "cRLSign"),
  encipherOnly(7,      org.bouncycastle.asn1.x509.KeyUsage.encipherOnly,     "encipherOnly"),
  decipherOnly(8,      org.bouncycastle.asn1.x509.KeyUsage.decipherOnly,     "decipherOnly");

  private int bit;

  private int bcUsage;

  private String[] names;

  KeyUsage(int bit, int bcUsage, String... names) {
    this.bit = bit;
    this.bcUsage = bcUsage;
    this.names = names;
  }

  public int getBit() {
    return bit;
  }

  public int getBcUsage() {
    return bcUsage;
  }

  public String getName() {
    return names[0];
  }

  public static KeyUsage getKeyUsage(String usage) {
    Args.notNull(usage, "usage");

    for (KeyUsage ku : KeyUsage.values()) {
      for (String name : ku.names) {
        if (name.equals(usage)) {
          return ku;
        }
      }
    }

    throw new IllegalArgumentException("invalid KeyUsage " + usage);
  }

  public static KeyUsage getKeyUsage(int bit) {
    for (KeyUsage ku : KeyUsage.values()) {
      if (ku.bit == bit) {
        return ku;
      }
    }

    throw new IllegalArgumentException("invalid KeyUsage(bit) " + bit);
  }

  public static KeyUsage getKeyUsageFromBcUsage(int bcUsage) {
    for (KeyUsage ku : KeyUsage.values()) {
      if (ku.bcUsage == bcUsage) {
        return ku;
      }
    }

    throw new IllegalArgumentException("invalid KeyUsage(bcUsage) " + bcUsage);
  }

}