佐野 拓 > Crypt-SMIME-0.10 > Crypt::SMIME

Download:
Crypt-SMIME-0.10.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.10   Source  

NAME ^

Crypt::SMIME - S/MIME message signing, verification, encryption and decryption ja; Crypt::SMIME::JA - S/MIMEの署名、検証、暗号化、復号化

SYNOPSIS ^

  use Crypt::SMIME;
  
  my $plain = <<'EOF';
  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;

DESCRIPTION ^

This module provides a class for handling S/MIME messages. It can sign, verify, encrypt and decrypt messages. It requires libcrypto (http://www.openssl.org) to work. ja; S/MIMEの署名、検証、暗号化、復号化を行うクラス。 libcrypto (http://www.openssl.org) が必要。

METHODS

new()
  my $smime = Crypt::SMIME->new();

The constructor takes no arguments. ja; 引数無し

setPrivateKey()
  $smime->setPrivateKey($key, $crt);
  $smime->setPrivateKey($key, $crt, $password);

Store a private key and its X.509 certificate into the instance. The private key will be used for signing and decryption. Note that this method takes a PEM string, not a name of a file which contains a key or a certificate. ja; 秘密鍵を設定する。ここで設定された秘密鍵は署名と復号化の際に用いられる。 ファイル名ではなく、鍵本体を渡す。

The private key and certificate must be encoded in PEM format. The method dies if it fails to load the key. ja; 対応しているフォーマットは PEM のみ。鍵の読み込みに失敗した場合はdieする。

setPublicKey()
  $smime->setPublicKey($crt);
  $smime->setPublicKey([$crt1, $crt2, ...]);

Store one or more X.509 certificates into the instance. The public keys will be used for signing, verification and encryption. ja; 公開鍵を設定する。ここで設定された公開鍵は署名への添付、署名の検証、 そして暗号化の際に用いられる。

The certificates must be encoded in PEM format. The method dies if it fails to load the certificates. ja; 対応しているフォーマットは PEM のみ。鍵の読み込みに失敗した場合はdieする。

sign()
  $signed_mime = $smime->sign($raw_mime);

Sign a MIME message and return an S/MIME message. The signature is always detached. ja; 署名を行い、MIMEメッセージを返す。可能な署名はクリア署名のみ。

Any headers except Content-*, MIME-* and Subject will be moved to the top-level of the MIME message. Subject header will be copied to both of the plain text part and the top-level for mail clients which can't properly handle S/MIME messages. ja; Content-*, MIME-* 及び Subject を除いたヘッダは multipartのトップレベルに移される。 Subject はS/MIMEを認識できないメーラのために, multipartの トップレベルと保護されるメッセージの両側に配置される。

signonly()
  $sign = $smime->signonly($prepared_mime);

Generate a signature from a MIME message. The resulting signature is encoded in Base64. The MIME message to be passed to this method should be preprocessed beforehand by the prepareSmimeMessage() method. You would rarely need to call this method directly. ja; 署名の計算を行う。 $sign はBASE64でエンコードされて返る。 $prepared_mime には, "prepareSmimeMessage" で返される値を渡す。

prepareSmimeMessage()
  ($prepared_mime, $outer_header)
      = $smime->prepareSmimeMessage($source_mime);

Preprocess a MIME message to be signed. $prepared_mime will be a string containing the processed MIME message, and $outer_header will be a string that is a list of headers to be moved to the top-level of MIME message. You would rarely need to call this method directly. ja; 署名用のメッセージを準備する。 $prepared_mime には著名用に修正されたMIMEメッセージを返す。 $outer_header は、S/MIMEの外側に付与するヘッダを返す。

The entity body of $source_mime will be directly copied to $prepared_mime. Any headers of $source_mime except Content-*, MIME-* and Subject will be copied to $prepared_mime, and those excluded headers will be copied to $outer_header. Note that the Subject header will be copied to both side exceptionally. ja; $prepared_mime の本文は$source_mimeと同じ物となるが、 ヘッダに関してはContent-*, MIME-*, Subject を除く全てが 取り除かれる。取り除かれたヘッダは $outer_header に返される。 S/MIMEメッセージを構築する際にはこれをS/MIMEメッセージのヘッダに追加する。 Subject ヘッダのみは $prepared_mime$outer_header の両方に 現れる点に注意。

check()
  $source_mime = $smime->check($signed_mime);

Verify a signature of S/MIME message and return a MIME message. The method dies if it fails to verify it. ja; 検証を行う。検証に失敗した場合はその理由と共にdieする。

encrypt()
  $encrypted_mime = $smime->encrypt($raw_mime);

Encrypt a MIME message and return a S/MIME message. ja; 暗号化を行う。

Any headers except Content-*, MIME-* and Subject will be moved to the top-level of the MIME message. Subject header will be copied to both of the plain text part and the top-level for mail clients which can't properly handle S/MIME messages. ja; Content-*, MIME-* 及び Subject を除いたヘッダは multipartのトップレベルにコピーされる。 Subject はS/MIMEを認識できないメーラのために, multipartの トップレベルと保護されるメッセージの両側に配置される。

decrypt()
  $decrypted_mime = $smime->decrypt($encrypted_mime);

Decrypt an S/MIME and return a MIME message. This method dies if it fails to decrypt it. ja; 復号化を行う。復号化に失敗した場合はその理由と共にdieする。

isSigned()
  $is_signed = $smime->isSigned($mime);

Return true if the given string is a signed S/MIME message. Note that if the message was encrypted after signing, this method returns false because in that case the signature is hidden in the encrypted message. ja; 渡されたMIMEメッセージがS/MIMEで署名されたものなら真を返す。 クリア署名かどうかは問わない。 署名後に暗号化したメッセージを渡した場合は、署名が直接見えない為、 偽を返す事に注意。

isEncrypted()
  $is_encrypted = $smime->isEncrypted($mime);

Return true if the given string is an encrypted S/MIME message. Note that if the message was signed with non-detached signature after encryption, this method returns false because in that case the encrypted message is hidden in the signature. ja; 渡されたMIMEメッセージがS/MIMEで暗号化されたものなら真を返す。 暗号化後に署名したメッセージを渡した場合は、暗号文が直接見えない為、 偽を返す事に注意。

AUTHOR ^

Copyright 2006-2007 YMIRLINK Inc. All Rights Reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself

Bug reports and comments to: tl@tripletail.jp

syntax highlighting: