.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "SMIME::JA 3pm" .TH SMIME::JA 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Crypt::SMIME::JA \- S/MIMEの署名、検証、暗号化、復号 .SH 概要 .IX Header "概要" .Vb 1 \& use Crypt::SMIME; \& \& my $plain = <<\*(AqEOF\*(Aq; \& From: alice@example.org \& To: bob@example.com \& Subject: Crypt::SMIME test \& \& This is a test mail. Please ignore... \& EOF \& \& my $smime = Crypt::SMIME\->new(); \& $smime\->setPrivateKey($privkey, $crt); \& # $smime\->setPublicKey([$icacert]); # if need be. \& \& my $signed = $smime\->sign($plain); \& print $signed; .Ve .SH 説明 .IX Header "説明" S/MIMEの署名、検証、暗号化、復号を行うクラス。 libcrypto () が必要。 .SH エクスポート .IX Header "エクスポート" 既定でエクスポートされるシンボルは無いが、次のシンボルはエクスポート可能である。 .ie n .IP """NO_CHECK_CERTIFICATE""" 4 .el .IP \f(CWNO_CHECK_CERTIFICATE\fR 4 .IX Item "NO_CHECK_CERTIFICATE" "\fBcheck()\fR" を参照。 .ie n .IP """FORMAT_SMIME""" 4 .el .IP \f(CWFORMAT_SMIME\fR 4 .IX Item "FORMAT_SMIME" .PD 0 .ie n .IP """FORMAT_ASN1""" 4 .el .IP \f(CWFORMAT_ASN1\fR 4 .IX Item "FORMAT_ASN1" .ie n .IP """FORMAT_PEM""" 4 .el .IP \f(CWFORMAT_PEM\fR 4 .IX Item "FORMAT_PEM" .PD "\fBextractCertificates()\fR" を参照。 .ie n .IP """:constants""" 4 .el .IP \f(CW:constants\fR 4 .IX Item ":constants" 上記のもの全てをエクスポートする。 .SH メソッド .IX Header "メソッド" .IP \fBnew()\fR 4 .IX Item "new()" .Vb 1 \& my $smime = Crypt::SMIME\->new(); .Ve .Sp 引数無し .IP \fBsetPrivateKey()\fR 4 .IX Item "setPrivateKey()" .Vb 2 \& $smime\->setPrivateKey($key, $crt); \& $smime\->setPrivateKey($key, $crt, $password); .Ve .Sp 秘密鍵を設定する。ここで設定された秘密鍵は署名と復号の際に用いられる。 ファイル名ではなく、鍵本体を渡す。 .Sp 対応しているフォーマットは PEM のみ。鍵の読み込みに失敗した場合はdieする。 .IP \fBsetPrivateKeyPkcs12()\fR 4 .IX Item "setPrivateKeyPkcs12()" .Vb 2 \& $smime\->setPrivateKeyPkcs12($key, $pkcs12); \& $smime\->setPrivateKeyPkcs12($key, $pkcs12, $password); .Ve .Sp 秘密鍵およびその X.509 証明書を PKCS#12 から読み込んで設定する。秘密鍵は署名と復号の際に用いられる。 読み込みに失敗した場合は die する。 .IP \fBsetPublicKey()\fR 4 .IX Item "setPublicKey()" .Vb 2 \& $smime\->setPublicKey($crt); \& $smime\->setPublicKey([$crt1, $crt2, ...]); .Ve .Sp 公開鍵を設定する。ここで設定された公開鍵は署名への添付、署名の検証、 そして暗号化の際に用いられる。 .Sp 対応しているフォーマットは PEM のみ。鍵の読み込みに失敗した場合はdieする。 .IP \fBsetPublicKeyStore()\fR 4 .IX Item "setPublicKeyStore()" .Vb 1 \& $smime\->setPublicKeyStore($path, ...); .Ve .Sp 信頼している証明書 (複数可) が入ったファイルやディレクトリのパス (複数可) を設定する。ここで設定された証明書ストアは、署名の検証の際に用いられる。 .Sp 証明書ストアの読み込みに失敗した場合はdieする。 .IP \fBsign()\fR 4 .IX Item "sign()" .Vb 1 \& $signed_mime = $smime\->sign($raw_mime); .Ve .Sp 署名を行い、MIMEメッセージを返す。可能な署名はクリア署名のみ。 .Sp \&\f(CW\*(C`Content\-*\*(C'\fR, \f(CW\*(C`MIME\-*\*(C'\fR 及び \f(CW\*(C`Subject\*(C'\fR を除いたヘッダは multipartのトップレベルに移される。 \&\f(CW\*(C`Subject\*(C'\fR はS/MIMEを認識できないメーラのために, multipartの トップレベルと保護されるメッセージの両側に配置される。 .Sp 元の MIME メッセージ、秘密鍵、またはその証明書のいずれかが汚染されている (tainted) ならば、署名されたメッセージも汚染される。 .IP \fBsignonly()\fR 4 .IX Item "signonly()" .Vb 1 \& $sign = $smime\->signonly($prepared_mime); .Ve .Sp 署名の計算を行う。 \&\f(CW$sign\fR はBASE64でエンコードされて返る。 \&\f(CW$prepared_mime\fR には, "prepareSmimeMessage" で返される値を渡す。 .Sp 元の MIME メッセージ、秘密鍵、またはその証明書のいずれかが汚染されている (tainted) ならば、生成された署名も汚染される。 .IP \fBprepareSmimeMessage()\fR 4 .IX Item "prepareSmimeMessage()" .Vb 2 \& ($prepared_mime, $outer_header) \& = $smime\->prepareSmimeMessage($source_mime); .Ve .Sp 署名用のメッセージを準備する。 \&\f(CW$prepared_mime\fR には署名用に修正されたMIMEメッセージを返す。 \&\f(CW$outer_header\fR は、S/MIMEの外側に付与するヘッダを返す。 .Sp \&\f(CW$prepared_mime\fR の本文は\f(CW$source_mime\fRと同じ物となるが、 ヘッダに関しては\f(CW\*(C`Content\-*\*(C'\fR, \f(CW\*(C`MIME\-*\*(C'\fR, \f(CW\*(C`Subject\*(C'\fR を除く全てが 取り除かれる。取り除かれたヘッダは \f(CW$outer_header\fR に返される。 S/MIMEメッセージを構築する際にはこれをS/MIMEメッセージのヘッダに追加する。 \&\f(CW\*(C`Subject\*(C'\fR ヘッダのみは \f(CW$prepared_mime\fR と \f(CW$outer_header\fR の両方に 現れる点に注意。 .IP \fBcheck()\fR 4 .IX Item "check()" .Vb 1 \& use Crypt::SMIME qw(:constants); \& \& $source_mime = $smime\->check($signed_mime); \& $source_mime = $smime\->check($signed_mime, $flags); .Ve .Sp 検証を行う。検証に失敗した場合はその理由と共にdieする。 .Sp \&\f(CW$flags\fR として \f(CW\*(C`Crypt::SMIME::NO_CHECK_CERTIFICATE\*(C'\fR オプションを指定した場合には、署名者の証明書チェーンを検証しない。 \&\f(CW$flags\fR のデフォルト値は \f(CW0\fR であり、この場合には全ての整合性についての検証を行う。 .Sp 元の S/MIME メッセージ, \f(CW$flags\fR, 検証時刻 ("setAtTime"), または 公開鍵の少なくとも一つが汚染されている(tainted) ならば、検証されたメッセージも汚染される。 .IP \fBencrypt()\fR 4 .IX Item "encrypt()" .Vb 1 \& $encrypted_mime = $smime\->encrypt($raw_mime); .Ve .Sp 暗号化を行う。 .Sp \&\f(CW\*(C`Content\-*\*(C'\fR, \f(CW\*(C`MIME\-*\*(C'\fR 及び \f(CW\*(C`Subject\*(C'\fR を除いたヘッダは multipartのトップレベルにコピーされる。 \&\f(CW\*(C`Subject\*(C'\fR はS/MIMEを認識できないメーラのために, multipartの トップレベルと保護されるメッセージの両側に配置される。 .Sp 元の MIME メッセージ、または公開鍵の少なくとも一つが汚染されている (tainted) ならば、暗号化されたメッセージも汚染される。 .IP \fBdecrypt()\fR 4 .IX Item "decrypt()" .Vb 1 \& $decrypted_mime = $smime\->decrypt($encrypted_mime); .Ve .Sp 復号を行う。復号に失敗した場合はその理由と共にdieする。 .Sp 元の S/MIME メッセージ、秘密鍵、またはその証明書のいずれかが汚染されている (tainted) ならば、復号されたメッセージも汚染される。 .IP \fBisSigned()\fR 4 .IX Item "isSigned()" .Vb 1 \& $is_signed = $smime\->isSigned($mime); .Ve .Sp 渡されたMIMEメッセージがS/MIMEで署名されたものなら真を返す。 クリア署名かどうかは問わない。 署名後に暗号化したメッセージを渡した場合は、署名が直接見えない為、 偽を返す事に注意。 .IP \fBisEncrypted()\fR 4 .IX Item "isEncrypted()" .Vb 1 \& $is_encrypted = $smime\->isEncrypted($mime); .Ve .Sp 渡されたMIMEメッセージがS/MIMEで暗号化されたものなら真を返す。 暗号化後に署名したメッセージを渡した場合は、暗号文が直接見えない為、 偽を返す事に注意。 .IP \fBsetAtTime()\fR 4 .IX Item "setAtTime()" .Vb 2 \& $yesterday = time \- (60*60*24); \& $smime\->setAtTime($yesterday); .Ve .Sp 検証時に用いる時刻を設定する。デフォルトは現在時刻。 UNIX epoch 形式でなければならない。 .SH 関数 .IX Header "関数" .IP \fBextractCertificates()\fR 4 .IX Item "extractCertificates()" .Vb 1 \& use Crypt::SMIME qw(:constants); \& \& @certs = @{Crypt::SMIME::extractCertificates($data)}; \& @certs = @{Crypt::SMIME::extractCertificates($data, FORMAT_SMIME)}; .Ve .Sp