openssl-migration

Tips to upgrade/migrate OpenSSL lib versions.

Project maintained by KazKobara Hosted on GitHub Pages — Theme by mattgraham

BN_*() 関数の実行に失敗する場合

症状1

以下のように BN_priv_rand_range() (または BN_rand_range() など)を実行し、

rc=BN_priv_rand_range(bn_p, bn_range_p);
if (1!=rc){
    ERR_print_errors_fp(stderr);
    goto Done;  /* メモリ解放などの後処理を行って return */
}

ERR_error_string()でエラーメッセージを表示させると、以下のように表示される場合

error:0308A071:bignum routines:bnrand_range:too many iterations

症状1への対処方法

BIGNUM * bn_p = NULL;

となっている場合には、以下のように変更:

BIGNUM * const bn_p = BN_secure_new();

なお、重要度の低い BIGNUM の場合には BN_new() でよい。

BIGNUM * const bn_p = BN_new();

そして、エラー処理を追加:

int32_t ret = 1;
unsigned long err;
if (NULL==bn_p){
    /* エラー処理 */
    ERR_print_errors_fp(stderr);
    goto Done;  /* メモリ解放などの後処理を行って return */
}

/* BIGNUM を使った処理 */

    ret = 0;
Done:
    BN_clear_free(bn_p);  /* 重要度の低い BIGNUM の場合には BN_free(bn_p); でよい */
    return ret;

ちなみに、これらのエラー時に perror() などでエラーメッセージを表示させても（原因がシステムコールや標準ライブラリに起因していない場合には） “: Success” と表示される。

症状1の補足

以下の表のように、bn_p=NULL の場合でも、例えば、BN_hex2bn()、BN_dec2bn() などの関数では、BIGNUM を生成し、そのアドレスを bn_p に格納してくれる。

しかしながら、そのような挙動にならない関数においては、BN_secure_new() や BN_new() で BIGNUM を初期化しておく必要がある。特に、*2 の注釈を付けた部分は、コンパイラによっては警告やエラーを出さず、runtime error となるため注意が必要。また、*1 において正常時にはエラーとならない場合も、ポインタ型変数にゴミが入っているとエラー処理の際に double free などの問題が起こるため避けなければならない。

Table. 1 BIGNUMポインタ型変数(bn_p)の初期化とBN_*()関数の組み合わせに対するコンパイル/実行結果の関係

Initialization of `bn_p`	None (not recommended)	`NULL`	`BN_new()` `BN_secure_new()`
BN_priv_rand_range(bn_p), BN_rand_range(bn_p) etc.	OK *1	Runtime error *2	OK
BN_priv_rand(bn_p), BN_rand(bn_p) etc.	OK *1	Segmentation fault *2	OK
BN_zero(bn_p), BN_one(bn_p), BN_set_word(bn_p,), BN_add(bn_p,), BN_sub(bn_p,), BN_lshift(bn_p,) etc.	Segmentation fault *1	Segmentation fault *2	OK
BN_hex2bn(&bn_p,), BN_dec2bn(&bn_p,) etc.	Segmentation fault 5,2	OK	OK
RSA_get0_key(, &bn_p, ), DH_get0_pqg(, &bn_p) etc.	OK *6	OK *4 (recommended)	OK *3

OK: No runtime error.
*1 Compiler warns.
*2 Compiler does not warn.
*3 Redundant since memory allocated by BN_new()/BN_secure_new() is not used.
*4 Note this does not mean &bn_p = NULL, but bn_p = NULL.
*5 Non-null pointers are tried to be used and cause segfault.
*6 Non-null pointers are not freed but will cause problems in case of error with *_free() and so on.

上記の実行環境

5.4.72-microsoft-standard-WSL2
gcc (Ubuntu 9.3.0-17ubuntu1~20.04) 9.3.0
OpenSSL 1.1.1k  25 Mar 2021

リストに戻る