001/*
002 * Copyright 2017-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2017-2024 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-2024 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.NotNull;
041import com.unboundid.util.Nullable;
042import com.unboundid.util.StaticUtils;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This enum defines a set of supported RSA private key versions.
050 */
051@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
052public enum RSAPrivateKeyVersion
053{
054  /**
055   * The two-prime RSA private key version.
056   */
057  TWO_PRIME(0, "two-prime"),
058
059
060
061  /**
062   * The multi RSA private key version.
063   */
064  MULTI(1, "multi");
065
066
067
068  // The integer value for this RSA private key version.
069  private final int intValue;
070
071  // The name for this RSA private key version.
072  @NotNull private final String name;
073
074
075
076  /**
077   * Creates a new RSA private key version with the provided information.
078   *
079   * @param  intValue  The integer value for the private key version.
080   * @param  name      The name for this private key version.  It must not be
081   *                   {@code null}.
082   */
083  RSAPrivateKeyVersion(final int intValue, @NotNull final String name)
084  {
085    this.intValue = intValue;
086    this.name = name;
087  }
088
089
090
091  /**
092   * Retrieves the integer value for this private key version.
093   *
094   * @return  The integer value for this private key version.
095   */
096  int getIntValue()
097  {
098    return intValue;
099  }
100
101
102
103  /**
104   * Retrieves the name for this private key version.
105   *
106   * @return  The name for this private key version.
107   */
108  @NotNull()
109  public String getName()
110  {
111    return name;
112  }
113
114
115
116  /**
117   * Retrieves the private key version for the provided integer value.
118   *
119   * @param  intValue  The integer value for the private key version to
120   *                   retrieve.
121   *
122   * @return  The private key version for the provided integer value, or
123   *          {@code null} if the provided version does not correspond to any
124   *          known private key version value.
125   */
126  @Nullable()
127  static RSAPrivateKeyVersion valueOf(final int intValue)
128  {
129    for (final RSAPrivateKeyVersion v : values())
130    {
131      if (v.intValue == intValue)
132      {
133        return v;
134      }
135    }
136
137    return null;
138  }
139
140
141
142  /**
143   * Retrieves the RSA private key version with the specified name.
144   *
145   * @param  name  The name of the RSA private key version to retrieve.  It must
146   *               not be {@code null}.
147   *
148   * @return  The requested RSA private key version, or {@code null} if no such
149   *          version is defined.
150   */
151  @Nullable()
152  public static RSAPrivateKeyVersion forName(@NotNull final String name)
153  {
154    switch (StaticUtils.toLowerCase(name))
155    {
156      case "twoprime":
157      case "two-prime":
158      case "two_prime":
159        return TWO_PRIME;
160      case "multi":
161        return MULTI;
162      default:
163        return null;
164    }
165  }
166}