class OpenSSL::Netscape::SPKI

要約

Netscape SPKI、もしくは SPKAC(Signed Public Key And Challenge) と呼ばれるデータフォーマットを扱うためのクラスです。

目次

特異メソッド
インスタンスメソッド

特異メソッド

new() -> OpenSSL::Netscape::SPKI[permalink][rdoc]
new(buf) -> OpenSSL::Netscape::SPKI

SPKI オブジェクトを生成します。

文字列を渡すと、PEM 形式、もしくは DER 形式のデータとみなし、その内容を読み込みます。

[PARAM] buf:
SPKI オブジェクトを生成するための文字列データ
[EXCEPTION] OpenSSL::Netscape::SPKIError:
オブジェクトの生成に失敗した場合に発生します

インスタンスメソッド

challenge -> String[permalink][rdoc]

SPKI オブジェクトに設定されたチャレンジ文字列を返します。

[EXCEPTION] OpenSSL::Netscape::SPKIError:
文字列が設定されていない場合に発生します

[SEE_ALSO] OpenSSL::Netscape::SPKI#challenge=

challenge=(chg)[permalink][rdoc]

SPKI オブジェクトにチャレンジ文字列を設定します。

[PARAM] chg:
設定する文字列
[EXCEPTION] OpenSSL::Netscape::SPKIError:
文字列の設定に失敗した場合に発生します

[SEE_ALSO] OpenSSL::Netscape::SPKI#challenge

public_key -> OpenSSL::PKey::PKey[permalink][rdoc]

SPKI オブジェクトに設定された公開鍵を返します。

[EXCEPTION] OpenSSL::Netscape::SPKIError:
公開鍵が設定されていない場合に発生します

[SEE_ALSO] OpenSSL::Netscape::SPKI#public_key=

public_key=(pubkey)[permalink][rdoc]

SPKI オブジェクトに公開鍵を設定します。

[PARAM] pubkey:
設定する公開鍵(OpenSSL::PKey::PKey オブジェクト)
[EXCEPTION] OpenSSL::Netscape::SPKIError:
公開鍵の設定に失敗した場合に発生します

[SEE_ALSO] OpenSSL::Netscape::SPKI#public_key

sign(key, digest) -> self[permalink][rdoc]

SPKI オブジェクトに署名をします。

[PARAM] key:
署名に使う秘密鍵(OpenSSL::PKey::PKey オブジェクト)
[PARAM] digest:
署名に使うダイジェスト関数(文字列もしくは OpenSSL::Digest オブジェクト)
[EXCEPTION] OpenSSL::Netscape::SPKIError:
署名に失敗した場合に発生します

[SEE_ALSO] OpenSSL::Netscape::SPKI#verify

to_der -> String[permalink][rdoc]

SPKI オブジェクトを DER 形式の文字列に変換します。

to_pem -> String[permalink][rdoc]
to_s -> String

SPKI オブジェクトを PEM 形式の文字列に変換します。

[EXCEPTION] OpenSSL::Netscape::SPKIError:
変換に失敗した場合に発生します
to_text -> String[permalink][rdoc]

SPKI オブジェクトを人間が読める形式の文字列に変換します。

verify(key) -> bool[permalink][rdoc]

署名を検証します。

検証に成功した場合は true を返し、失敗した場合は false を返します。

[PARAM] key:
署名に使う公開鍵(OpenSSL::PKey::PKey オブジェクト)
[EXCEPTION] OpenSSL::Netscape::SPKIError:
検証時にエラーが起きた場合に発生します

[SEE_ALSO] OpenSSL::Netscape::SPKI#sign