3rd Party Security Providerの導入について

SAML Security token 取得の実装で、Bouncy Castleライブラリがpom.xmlにありました。
Bouncy Castleライブラリを導入した理由について、本稿で説明します。

POC of consuming Sharepoint onlineでも触れましたが、Sharepoint Onlineサイトはhttpsプロトコルを使用します。
つまり、クライアントとサーバー間でSSL handshakeが発生します。
SSL handshakeでは、TLSバージョン及び、Cipher Suite(暗号スイート）¹⁾の交換が行われます。
Sharepoint OnlineサイトのTLSバージョンと、Cipher Suiteはssl lab testで確認できます。
テスト結果で、protocolsとCipher Suites部分を以下に示します。

一方、Java 7が提供するTLS Versionは、TLS1.0, TLS1.1, TLS1.2です。²⁾
Cipher Suiteについては、以下に示します。

見て、気づいたかも知れませんが、Shatepoint onlineサイト要求のCipher Suiteと一致するのが見当たりません。
これが、Bouncy Castleライブラリを導入した理由になります。

Bouncy CastleはJCE(Java Cryptography Enxtension)及びJSSE(Java Security Socket Extension)のProviderです。
Bouncy CastleがサポートするCipher Suiteについては、ReferenceのBC-FJA-(D)TLSUserGuide-1.0.9.pdfの「Appendix B – Supported Cipher Suites」部分を参照してください。
該当する部分を以下に示します。

Bouncy Castle以外にもConscryptというProviderは上記一部分のCipher Suite⁴⁾を提供しますが、利用可能なPlatformに制限⁵⁾があります。

Bouncy Castleを適用するコードを以下に示します。

  private static final String JCE_PROVIDER_BOUNCY_CASTLE_FIPS = "BCFIPS";
  private static final String BOUNCY_CASTLE_RNG_HYBRID_MODE = "C:HYBRID;ENABLE{ALL};";
  private static final byte[] NONCE = Strings.toByteArray("number only used once");
 
  /**
   * setup BouncyCastleFipsProvider
   * <br>
   * @throws RuntimeException
   */
  public static void setUpProvider() throws RuntimeException {
    /*
     * Insert BouncyCastle's FIPS-compliant encryption and SSL providers.
     */
    BouncyCastleFipsProvider _bcFipsProvider = new BouncyCastleFipsProvider(BOUNCY_CASTLE_RNG_HYBRID_MODE);  ★Point1
 
    //setup default SecureRandom
    setDefaultDrbg();
 
    /*
     * We remove BCFIPS provider pessimistically. This is a no-op if provider does not exist.
     * This is necessary to always add it to the first position when calling insertProviderAt.
     *
     * JavaDoc for insertProviderAt states:
     *   "A provider cannot be added if it is already installed."
     */
    Security.removeProvider(JCE_PROVIDER_BOUNCY_CASTLE_FIPS);
    Security.insertProviderAt(_bcFipsProvider, 1);  ★Point2
  }//setUpProvider
 
  //set default SecureRandom
  private static void setDefaultDrbg() {
    EntropySourceProvider _entSource = new BasicEntropySourceProvider(new SecureRandom(), true);
    //DRBG(Deterministic Random Bit Generators)
    FipsDRBG.Builder _drgbBldr = FipsDRBG.SHA512.fromEntropySource(_entSource)
        .setSecurityStrength(256)
        .setEntropyBitsRequired(256);
    CryptoServicesRegistrar.setSecureRandom(_drgbBldr.build(NONCE, true));  ★Point3
  }//setDefaultDrbg

★Point1
FIPSモードでProviderを生成します。

★Point2
Providerを最優先にするために、位置を指定します。インストール済みの場合は、追加されません。

★Point3
デフォルトのSecureRandomアルゴリズムを登録します。
登録しない場合、SSLContextのインスタンスを生成する際、ものすごい時間が掛かる場合があります。

• Cipher suite (暗号スイート)
• BC-FJA-(D)TLSUserGuide-1.0.9
• The Bouncy Castle FIPS Java API in 100 Examples
• Conscrypt - A Java Security Provider