001/*
002 * nimbus-jose-jwt
003 *
004 * Copyright 2012-2021, Connect2id Ltd.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.jose.crypto.bc;
019
020
021import java.security.Provider;
022import java.security.Security;
023
024
025/**
026 * BouncyCastle FIPS JCA provider singleton, intended to prevent memory leaks
027 * by ensuring a single instance is loaded at all times. Application code that
028 * needs a BouncyCastle FIPS JCA provider should use the {@link #getInstance()}
029 * method to obtain an instance.
030 *
031 * <p>Requires the following optional dependency:
032 *
033 * <pre>
034 * &lt;dependency&gt;
035 *     &lt;groupId&gt;org.bouncycastle&lt;/groupId&gt;
036 *     &lt;artifactId&gt;bc-fips&lt;/artifactId&gt;
037 *     &lt;version&gt;[1.0.2,2.0.0)&lt;/version&gt;
038 *     &lt;optional&gt;true&lt;/optional&gt;
039 * &lt;/dependency&gt;
040 * </pre>
041 *
042 * <p><strong>Important:</strong> The plain BouncyCastle JCA provider
043 * dependency must not be present to prevent class conflicts!
044 *
045 * @author Vladimir Dzhuvinov
046 * @version 2025-01-02
047 */
048public final class BouncyCastleFIPSProviderSingleton {
049
050
051        /**
052         * The BouncyCastle FIPS provider, lazily instantiated.
053         */
054        private static Provider bouncyCastleFIPSProvider;
055
056
057        /**
058         * Prevents external instantiation.
059         */
060        private BouncyCastleFIPSProviderSingleton() { }
061
062
063        /**
064         * Returns a BouncyCastle FIPS JCA provider instance.
065         *
066         * @return The BouncyCastle FIPS JCA provider instance.
067         */
068        public static Provider getInstance() {
069
070                if (bouncyCastleFIPSProvider == null) {
071                        bouncyCastleFIPSProvider = Security.getProvider("BCFIPS");
072                }
073                return bouncyCastleFIPSProvider;
074        }
075}