org.jitsi.srtp.crypto.HmacSha1 Maven / Gradle / Ivy

/*
 * Copyright @ 2015 - present 8x8, Inc
 *
 * 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.jitsi.srtp.crypto;

import java.security.*;
import java.util.*;
import javax.crypto.*;

import org.bouncycastle.jce.provider.*;
import org.jitsi.srtp.crypto.Aes.*;
import org.jitsi.utils.logging2.*;

/**
 * Implements a factory for an HMAC-SHA1 {@link Mac}.
 *
 * @author Lyubomir Marinov
 */
public class HmacSha1
{
    private static List providers;
    private static Provider jitsiProvider;

    private static synchronized List getProviders(Logger logger)
    {
        if (providers == null)
        {
            providers = new ArrayList<>(3);
            if (JitsiOpenSslProvider.isLoaded())
            {
                jitsiProvider = new JitsiOpenSslProvider();
                providers.add(jitsiProvider);
            }

            providers.add(Security.getProvider("SunJCE"));
            try
            {
                Provider pkcs11Provider = SunPKCS11CipherFactory.getProvider();
                if (pkcs11Provider != null)
                {
                    providers.add(pkcs11Provider);
                }
            }
            catch (Exception e)
            {
                logger.debug(() -> "PKCS#11 provider not available for HMAC: " + e.getMessage());
            }
            providers.add(new BouncyCastleProvider());
        }

        return providers;
    }

    /**
     * Initializes a new {@link Mac} instance which implements a keyed-hash
     * message authentication code (HMAC) with SHA-1.
     *
     * @param parentLogger the logging context
     * @return a new {@link Mac} instance which implements a keyed-hash message
     * authentication code (HMAC) with SHA-1
     */
    public static Mac createMac(Logger parentLogger)
    {
        // Try providers in order
        for (Provider p : getProviders(parentLogger))
        {
            try
            {
                Mac mac;
                if (p == jitsiProvider)
                {
                    /* Work around the fact that we can't install our own security
                     * providers on Oracle JVMs.
                     */
                    mac = new MacWrapper(new OpenSslHmacSpi(), p, "HmacSHA1");
                }
                else
                {
                    mac = Mac.getInstance("HmacSHA1", p);
                }
                parentLogger.debug(() -> "Using " + p.getName() + " for HMAC");
                return mac;
            }
            catch (NoSuchAlgorithmException e)
            {
                // continue
            }
        }

        throw new RuntimeException("No HmacSHA1 provider found");
    }

    private static class MacWrapper extends Mac
    {
        public MacWrapper(MacSpi macSpi, Provider provider, String s)
        {
            super(macSpi, provider, s);
        }
    }
}