https://github.com/yasuenag/hwrand

SecureRandom powered by x86 processor
https://github.com/yasuenag/hwrand

java randomization rdrand rdseed

Last synced: 4 months ago
JSON representation

SecureRandom powered by x86 processor

• Host: GitHub
• URL: https://github.com/yasuenag/hwrand
• Owner: YaSuenag
• Created: 2015-12-29T13:03:29.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2025-02-02T10:00:08.000Z (over 1 year ago)
• Last Synced: 2025-08-28T13:31:41.878Z (10 months ago)
• Topics: java, randomization, rdrand, rdseed
• Language: Java
• Homepage:
• Size: 84 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
HWRand

![CodeQL](../../workflows/CodeQL/badge.svg)

===================

HWRandはIntelプロセッサのRDRAND、RDSEED命令を用いた乱数生成を行うためのSecureRandom実装です。

RDRANDはNIST SP 800-90A、RDSEEDはNIST SP 800-90BとCに対応しているようです。

[The Difference Between RDRAND and RDSEED](https://software.intel.com/en-us/blogs/2012/11/17/the-difference-between-rdrand-and-rdseed)

NIST SP 800-90A～Cは [JEP 273: DRBG-Based SecureRandom Implementations](http://openjdk.java.net/jeps/273) として、JDK 9で実装が追加される予定ですが、HWRandを利用することで、Linux x86/x86_64環境ではJDK 8以前でもこれらの乱数が利用可能となります。

# 対応環境

* JDK 6以降

* Linux x86_64

   * 動作チェックはUbuntu 20.04 (WSL2) x86_64で実施

   * ビルドにはJDK、GCC、GNU Make、GNU Assembler、Maven必須

JDK 22 以降の場合は Foreign Function & Memory API を用いた、RDRAND / RDSEED 各命令のダイレクト呼び出しをサポートします。これは Linux だけでなく Windows でも動作します。

JDK 25 以降の場合は JVMCI を用いた RDRAND / RDSEED の呼び出しもサポートします。これも Windows でも動作しますが利用時には Java 起動オプションの設定が必要です。 `java` 起動引数に `@jvmci.opts` のように [jvmci.opts](jvmci.opts) またはその記述内容を設定する必要があります。

JVMCI サポートを無効にしたい場合は実行時に `-Dhwrand.disableJVMCI=true` のように `hwrand.disableJVMCI` システムプロパティを `true` に設定します。JVMCI サポートが無効の場合は JVMCI 関連オプションを設定する必要はありません。

> [!TIP]

> JVMCI の実装には [ffmasm](https://github.com/YaSuenag/ffmasm) 付属の [jvmci-adapter](https://github.com/YaSuenag/ffmasm/packages/2776023) を利用しています。

> [!NOTE]

> jvmci.opts には Unnamed Module の設定が記述されています。名前付きモジュールで HWRand を利用する場合は `jdk.internal.vm.ci` のエクスポート先を `com.yasuenag.ffmasmtools.jvmci` に設定してください。

# ビルド方法

```

JAVA_HOME=/path/to/jdk8 mvn compile

JAVA_HOME=/path/to/jdk22 mvn compile

JAVA_HOME=/path/to/jdk25 mvn compile

JAVA_HOME=/path/to/jdk25 mvn package

```

> [!TIP]

> テストは各 JDK バージョンで `mvn verify` を行うことで実施できます。

# 利用方法

* [SecureRandom#getInstance(String)](http://docs.oracle.com/javase/jp/8/docs/api/java/security/SecureRandom.html#getInstance-java.lang.String-) にそれぞれの引数を与えてインスタンスを取得してください。

    * RDRAND（NIST SP 800-90A）

        * X86RdRand

        * FFMX86RdRand

        * JVMCIX86RdRand

    * RDSEED（NIST SP 800-90B/C）

        * X86RdSeed

        * FFMX86RdSeed

        * JVMCIX86RdSeed

* 具体的な利用方法については [実装例](examples/all-randoms/src/main/java/com/yasuenag/hwrand/example/allrandoms/Main.java) もご覧ください。

# 注意

* HWRandは、実行されるプロセッサがRDRAND、RDSEEDをサポートするか判断し、未サポートのCPUの上では当該機能が利用できません。

    * RDRAND（NIST SP 800-90A）

        * Ivy Bridge以降

    * RDSEED（NIST SP 800-90B/C）

        * Broadwell以降

* 実装は [SecureRandomSpi](http://docs.oracle.com/javase/jp/8/docs/api/java/security/SecureRandomSpi.html) に対して行っていますが、engineGenerateSeed()とengineNextBytes()は同じ挙動（同じソースからの乱数取得）となります。また、engineSetSeed()は何も行いません（空実装です）。

* クラッシュ等、アプリケーションが異常終了した場合は一時ディレクトリに生成されるネイティブライブラリ（ `libhwrandx86-*.so` ）が残存する場合があります（デフォルトでは `/tmp` 配下）。

# License

GNU General Public License v2