4.4.8. SSLを利用するためのインタフェース
 
4.4.8.1. SSLについて
 
4.4.8.2. CORBA::ORBクラス
 
4.4.8.3. CORBA::Objectクラス
 
4.4.8.4. そのほかの関数

名前

CORBA::ORB::__use_ssl - SSLポート番号を設定する

形式

機能説明

SSLを用いた通信で使用するポート番号を設定します。
この設定は、サーバ側で有効です。

引数portには、ポート番号を指定します。

戻り値

ありません。

エラー

起こりません。

注意

ポート番号に0を設定することはできません。
この関数は、CORBA::ORB_init関数の直後に呼び出してください。


名前

CORBA::ORB::__cert_request - クライアント証明書を要求する

形式

機能説明

クライアント側に対して、クライアント証明書を要求します。
この設定は、サーバ側で有効です。

引数bには、以下のいずれかの値を指定します。

戻り値

ありません。

エラー

起こりません。

注意

この関数は、CORBA::ORB_init関数の直後に呼び出してください。


名前

CORBA::ORB::__accept_mode - アクセプトモードを設定する

形式

機能説明

アクセプトモードを設定します。
この設定は、サーバ側で有効です。

引数mには、下記のいずれかの値を指定します。

戻り値

ありません。

エラー

起こりません。

関連項目

Ob_is_ssl_connection

注意

この関数は、CORBA::ORB_init関数の直後に呼び出してください。


名前

CORBA::ORB::__server_cert_key - サーバの鍵IDを指定する。

形式

機能説明

サーバの鍵IDを指定します。
この設定は、サーバ側で有効です。

引数keyには、SecureWare/SecurityPackに登録したサーバの鍵IDを指定します。

戻り値

ありません。

エラー

以下の例外がthrowされます。

関連項目

CORBA::ORB::__client_cert_key

注意

この関数は、CORBA::ORB_init関数の直後に呼び出してください。


名前

CORBA::ORB::__client_cert_key - クライアントの鍵IDを指定する。

形式

機能説明

クライアントの鍵IDを指定します。
この設定は、クライアント側で有効です。

引数keyには、SecureWare/SecurityPackに登録したクライアントの鍵IDを指定します。

戻り値

ありません。

エラー

以下の例外がthrowされます。

関連項目

CORBA::ORB::__server_cert_key

注意

この関数は、CORBA::ORB_init関数の直後に呼び出してください。


名前

CORBA::Object::__client_use_ssl - SSLを使用した通信を行うかどうかを設定する

形式

機能説明

SSLと非SSLの通信を受け付けるサーバにリクエストを発行する際、SSL通信を使用するかどうかを設定します。
クライアント側がSSLを使用できない環境の場合、この設定は無視されます。

引数modeには、以下のいずれかの値を設定します。

戻り値

ありません。

エラー

起こりません。

関連項目

CORBA::ORB::__accept_mode

注意事項

他社のORBを使用して構築されたサーバと接続する場合は、この設定を使用しないでください。


名前

Ob_ssl_initialize - SSLを初期化する

形式

機能説明

SSLを初期化します。

戻り値

正常に初期化できたときは1を返します。失敗したときは0を返します。

エラー

以下の例外がthrowされます

関連項目

Ob_ssl_finalize


名前

Ob_ssl_finalize - Ob_ssl_initialize関数で確保した領域を解放する

形式

機能説明

Ob_ssl_initialize関数で確保した領域を解放します。

戻り値

正常に終了処理ができたときは1を返します。失敗したときは0を返します。

エラー

起こりません。

関連項目

Ob_ssl_initialize


名前

Ob_ssl_use_certificate - 証明書を設定する

形式

機能説明

X.509証明書を設定します。

targetには、下記のいずれかの値を指定します。

x509には、X.509証明書を指定します。

プログラム例を以下に示します。

戻り値

正常に設定できたときは1を返します。失敗したときは1以外の値を返します。

エラー

以下の例外がthrowされます。


名前

Ob_ssl_use_certificate_file - ファイル形式の証明書を設定する

形式

機能説明

ファイル形式の証明書を設定します。

targetには、下記のいずれかの値を指定します。

fileには、証明書の格納されたファイルのパスを指定します。

typeには、下記のいずれかの値を指定します。

プログラム例を以下に示します。

戻り値

正常に設定できたときは1を返します。失敗したときは1以外の値を返します。

エラー

以下の例外がthrowされます。


名前

Ob_ssl_use_privateKey - プライベートカギを設定する

形式

機能説明

プライベートカギを設定します。

targetには、下記のいずれかの値を指定します。

pkeyには、プライベートカギを指定します。

プログラム例はOb_ssl_use_certificateを参照してください。

戻り値

正常に設定できたときは1を返します。失敗したときは1以外の値を返します。

エラー

以下の例外がthrowされます。


名前

Ob_ssl_use_privateKey_file - ファイル形式のプライベートカギを設定する

形式

機能説明

ファイル形式のプライベートカギを設定します。

targetには、下記のいずれかの値を指定します。

fileには、プライベートカギの格納されたファイルのパスを指定します。

typeには、下記のいずれかの値を指定します。

プログラム例はOb_ssl_use_certificate_fileを参照してください。

戻り値

正常に設定できたときは1を返します。失敗したときは1以外の値を返します。

エラー

以下の例外がthrowされます。


名前

Ob_ssl_check_privateKey
- 証明書とプライベートカギのセットが一致するか調べる

形式

機能説明

SSLコネクションに対する証明書とプライベートカギのセットが一致するか調べます。

引数targetには、下記のいずれかの値を指定します。

プログラム例はOb_ssl_use_certificate_fileを参照してください。

戻り値

証明書とプライベートカギが一致したときは1を返します。一致しないときは1以外の値を返します。

エラー

以下の例外がthrowされます。


名前

Ob_ssl_load_verify_locations
- 信頼できるCA証明書(TrustedCA)の格納場所を設定する

形式

機能説明

相手の証明書を検証するときに必要となる、信頼できるCA証明書(TrustedCA)の格納場所を設定します。

targetには、下記のいずれかの値を指定します。

CAfileには、TrustedCAのPEMエンコードされたファイルを指定します。

CApathには、CAfileのサーチディレクトリを指定します。

プログラム例を以下に示します。

戻り値

正常に設定できたときは1を返します。失敗したときは1以外の値を返します。

エラー

以下の例外がthrowされます。


名前

Ob_ssl_set_cert_verify_cb - 組み込み検証関数の代替関数を設定する

形式

機能説明

組み込み検証関数の代替関数を設定します。
証明書の検証時に設定したコールバック関数が呼び出されます。

targetには、下記のいずれかの値を指定します。

cbには、コールバック関数を指定します。

argには、コールバック関数の第二引数に渡す任意の値を指定します。

戻り値

正常に設定できたときは1を返します。失敗したときは1以外の値を返します。

エラー

以下の例外がthrowされます。

関連項目

Ob_ssl_set_verify

注意

この設定を行うとOb_ssl_set_verify関数で設定したコールバック関数は呼び出されません。

検証関数の実装には電子証明書に関する多くの知識と「RSA BSAFE SSL-C」等の開発キットが必要となります。


名前

Ob_ssl_set_verify - 証明書を検証するコールバック関数を設定する

形式

機能説明

クライアントあるいはサーバ側のいずれかに受け取られた証明書は組み込み検証関数によって検証されます。
この関数でコールバックを設定しておくと、組み込み検証関数の後に呼び出されます。 組み込み検証関数の検証結果は、コールバック関数の第1引数として渡されます。証明書を信用する場合は1、拒絶する場合は0が渡されます。
このコールバック関数の戻り値が1ならば証明書は信用され、0ならば拒絶されます。

targetには、下記のいずれかの値を指定します。

modeには、以下の値を指定します。

cbには、コールバック関数を指定します。

プログラム例を以下に示します。

戻り値

正常に設定できたときは1を返します。失敗したときは1以外の値を返します。

エラー

以下の例外がthrowされます

関連項目

Ob_ssl_set_cert_verify_cb

注意

Ob_ssl_set_cert_verify_cb関数でコールバック関数の設定を行うと、この関数で設定したコールバック関数は呼び出されません。


名前

Ob_ssl_set_client_cert_cb
- サーバから証明書を要求されたときに使うコールバック関数を指定する

形式

機能説明

サーバからクライアントの証明書を要求されたときに呼び出されるコールバック関数を指定します。
複数のクライアント証明書を選択して使用する場合などに用います。コールバック関数の第2引数には証明書を、第3引数にはプライベートカギを設定します。証明書とプライベートカギを設定した場合、コールバックの戻り値を1にします。設定しなかった場合は0にします。
この設定は、クライアント側で有効です。

引数cbには、コールバック関数を指定します。

プログラム例を以下に示します。

戻り値

正常に設定できたときは1を返します。失敗したときは1以外の値を返します。

エラー

以下の例外がthrowされます。


名前

Ob_X509_STORE_CTX_get_current_cert
- X.509証明書格納コンテキストから検証するX.509証明書を取り出す

形式

機能説明

証明書検証コールバック関数に渡されたX.509証明書格納コンテキストから X.509証明書を取り出します。

引数x509_store_ctxには、X.509証明書格納コンテキストを指定します。

プログラム例はOb_ssl_set_verifyを参照してください。

戻り値

検証用のX.509が格納されていればX.509証明書を、格納されていなければ0を返します。

エラー

以下の例外がthrowされます


名前

Ob_X509_get_version - X.509証明書からバージョン番号を取り出す

形式

機能説明

X.509証明書からバージョン番号を取り出します。

引数x509には、X.509証明書を指定します。

プログラム例はOb_ssl_set_verifyを参照してください。

戻り値

証明書のバージョン番号が返ります。

エラー

以下の例外がthrowされます。


名前

Ob_X509_get_serialNumber - X.509証明書からシリアル番号を取り出す

形式

機能説明

X.509証明書からシリアル番号を取り出します。

引数x509には、X.509証明書を指定します。

プログラム例はOb_ssl_set_verifyを参照してください。

戻り値

証明書のシリアル番号を返します。

エラー

以下の例外がthrowされます。


名前

Ob_X509_get_issuer_name - X.509証明書から発行者名を取り出す

形式

機能説明

X.509証明書から発行者名を取り出します。

引数x509には、X.509証明書を指定します。

プログラム例はOb_ssl_set_verifyを参照してください。

戻り値

証明書の発行者名を返します。

エラー

以下の例外がthrowされます。


名前

Ob_X509_get_notBefore - X.509証明書から有効日を取り出す

形式

機能説明

X.509証明書から有効日を取り出します。

引数x509には、X.509証明書を指定します。

プログラム例はOb_ssl_set_verifyを参照してください。

戻り値

証明書の有効日を返します。

エラー

以下の例外がthrowされます。


名前

Ob_X509_get_notAfter - X.509証明書から有効期限を取り出す

形式

機能説明

X.509証明書から有効期限を取り出します。

引数x509には、X.509証明書を指定します。

プログラム例はOb_ssl_set_verifyを参照してください。

戻り値

証明書の有効期限を返します。

エラー

以下の例外がthrowされます。


名前

Ob_X509_get_subject_name - X.509証明書から対象者名を取り出す

形式

機能説明

証明書から対象者名を取り出します。

引数x509には、X.509証明書を指定します。

プログラム例はOb_ssl_set_verifyを参照してください。

戻り値

証明書の対象者名を返します。

エラー

以下の例外がthrowされます。


名前

Ob_create_X509 - X.509証明書の作成

形式

機能説明

PEMフォーマットのデータ(配列)からX.509証明書を作成します。

引数dataには、データ(配列)を指定します。

引数sizeには、データ(配列)のサイズ(要素数)を指定します。

引数cbには、0を指定します。 この引数は将来の拡張のために存在します。

プログラム例はOb_ssl_use_certificateを参照してください。

戻り値

X.509証明書、または 0 を返します。

エラー

以下の例外がthrowされます。

関連項目

Ob_X509_free


名前

Ob_X509_free - X.509証明書の解放

形式

機能説明

X.509証明書を解放します。

引数x509には、X.509証明書を指定します。

プログラム例はOb_ssl_use_certificateを参照してください。

戻り値

ありません。

エラー

以下の例外がthrowされます。

関連項目

Ob_create_X509


名前

Ob_create_EVP_PKEY - プライベートカギの作成

形式

機能説明

PEMフォーマットのデータ(配列)からプライベートカギを作成します。

引数dataには、データ(配列)を指定します。

引数sizeには、データ(配列)のサイズ(要素数)を指定します。

引数cbには、0を指定します。 この引数は将来の拡張のために存在します。

プログラム例はOb_ssl_use_certificateを参照してください。

戻り値

プライベートカギ、または 0 を返します。

エラー

以下の例外がthrowされます。

関連項目

Ob_EVP_PKEY_free


名前

Ob_EVP_PKEY_free - プライベートカギの解放

形式

機能説明

プライベートカギを解放します。

引数pkeyには、プライベートカギを指定します。

プログラム例はOb_ssl_use_certificateを参照してください。

戻り値

ありません。

エラー

以下の例外がthrowされます。

関連項目

Ob_create_EVP_PKEY


名前

Ob_is_ssl_connection - SSL接続かどうかを調べる

形式

機能説明

クライアントが、SSLポート経由で接続してきたかどうかを調べます。
SSL通信か否かによって処理を分岐したい場合などに使用します。

サーバメソッドの実装部で使用することができ、それ以外の場所で使用した場合の戻り値は不定です。

プログラム例を以下に示します。

戻り値

SSLポート経由で接続されたときは1を返します。そうでなければ0を返します。

エラー

起こりません。

関連項目

CORBA::ORB::__accept_mode