001/* 002 * Copyright 2017-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2017-2020 Ping Identity Corporation 007 * 008 * Licensed under the Apache License, Version 2.0 (the "License"); 009 * you may not use this file except in compliance with the License. 010 * You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, software 015 * distributed under the License is distributed on an "AS IS" BASIS, 016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 017 * See the License for the specific language governing permissions and 018 * limitations under the License. 019 */ 020/* 021 * Copyright (C) 2017-2020 Ping Identity Corporation 022 * 023 * This program is free software; you can redistribute it and/or modify 024 * it under the terms of the GNU General Public License (GPLv2 only) 025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only) 026 * as published by the Free Software Foundation. 027 * 028 * This program is distributed in the hope that it will be useful, 029 * but WITHOUT ANY WARRANTY; without even the implied warranty of 030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 031 * GNU General Public License for more details. 032 * 033 * You should have received a copy of the GNU General Public License 034 * along with this program; if not, see <http://www.gnu.org/licenses>. 035 */ 036package com.unboundid.util.ssl.cert; 037 038 039 040import com.unboundid.util.StaticUtils; 041import com.unboundid.util.ThreadSafety; 042import com.unboundid.util.ThreadSafetyLevel; 043 044 045 046/** 047 * This enum defines a set of supported RSA private key versions. 048 */ 049@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 050public enum RSAPrivateKeyVersion 051{ 052 /** 053 * The two-prime RSA private key version. 054 */ 055 TWO_PRIME(0, "two-prime"), 056 057 058 059 /** 060 * The multi RSA private key version. 061 */ 062 MULTI(1, "multi"); 063 064 065 066 // The integer value for this RSA private key version. 067 private final int intValue; 068 069 // The name for this RSA private key version. 070 private final String name; 071 072 073 074 /** 075 * Creates a new RSA private key version with the provided information. 076 * 077 * @param intValue The integer value for the private key version. 078 * @param name The name for this private key version. It must not be 079 * {@code null}. 080 */ 081 RSAPrivateKeyVersion(final int intValue, final String name) 082 { 083 this.intValue = intValue; 084 this.name = name; 085 } 086 087 088 089 /** 090 * Retrieves the integer value for this private key version. 091 * 092 * @return The integer value for this private key version. 093 */ 094 int getIntValue() 095 { 096 return intValue; 097 } 098 099 100 101 /** 102 * Retrieves the name for this private key version. 103 * 104 * @return The name for this private key version. 105 */ 106 public String getName() 107 { 108 return name; 109 } 110 111 112 113 /** 114 * Retrieves the private key version for the provided integer value. 115 * 116 * @param intValue The integer value for the private key version to 117 * retrieve. 118 * 119 * @return The private key version for the provided integer value, or 120 * {@code null} if the provided version does not correspond to any 121 * known private key version value. 122 */ 123 static RSAPrivateKeyVersion valueOf(final int intValue) 124 { 125 for (final RSAPrivateKeyVersion v : values()) 126 { 127 if (v.intValue == intValue) 128 { 129 return v; 130 } 131 } 132 133 return null; 134 } 135 136 137 138 /** 139 * Retrieves the RSA private key version with the specified name. 140 * 141 * @param name The name of the RSA private key version to retrieve. It must 142 * not be {@code null}. 143 * 144 * @return The requested RSA private key version, or {@code null} if no such 145 * version is defined. 146 */ 147 public static RSAPrivateKeyVersion forName(final String name) 148 { 149 switch (StaticUtils.toLowerCase(name)) 150 { 151 case "twoprime": 152 case "two-prime": 153 case "two_prime": 154 return TWO_PRIME; 155 case "multi": 156 return MULTI; 157 default: 158 return null; 159 } 160 } 161}