[ Index ]

MailPress 7.2

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    

title

Body

[close]

/mp-includes/composer/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Signers/ -> SMimeSigner.php (summary)

(no description)

File Size: 542 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Swift_Signers_SMimeSigner:: (21 methods):
  __construct()
  setSignCertificate()
  setEncryptCertificate()
  getSignCertificate()
  getSignPrivateKey()
  setSignThenEncrypt()
  isSignThenEncrypt()
  reset()
  setWrapFullMessage()
  signMessage()
  getAlteredHeaders()
  smimeSignMessage()
  smimeEncryptMessage()
  copyHeaders()
  copyHeader()
  clearAllHeaders()
  wrapMimeMessage()
  parseSSLOutput()
  streamToMime()
  parseStream()
  copyFromOpenSSLOutput()


Class: Swift_Signers_SMimeSigner  - X-Ref

MIME Message Signer used to apply S/MIME Signature/Encryption to a message.

__construct($signCertificate = null, $signPrivateKey = null, $encryptCertificate = null)   X-Ref
Constructor.

param: string|null $signCertificate
param: string|null $signPrivateKey
param: string|null $encryptCertificate

setSignCertificate($certificate, $privateKey = null, $signOptions = PKCS7_DETACHED, $extraCerts = null)   X-Ref
Set the certificate location to use for signing.

param: string       $certificate
param: string|array $privateKey  If the key needs an passphrase use array('file-location', 'passphrase') instead
param: int          $signOptions Bitwise operator options for openssl_pkcs7_sign()
param: string       $extraCerts  A file containing intermediate certificates needed by the signing certificate
return: $this

setEncryptCertificate($recipientCerts, $cipher = null)   X-Ref
Set the certificate location to use for encryption.

param: string|array $recipientCerts Either an single X.509 certificate, or an assoc array of X.509 certificates.
param: int          $cipher
return: $this

getSignCertificate()   X-Ref

return: string

getSignPrivateKey()   X-Ref

return: string

setSignThenEncrypt($signThenEncrypt = true)   X-Ref
Set perform signing before encryption.

The default is to first sign the message and then encrypt.
But some older mail clients, namely Microsoft Outlook 2000 will work when the message first encrypted.
As this goes against the official specs, its recommended to only use 'encryption -> signing' when specifically targeting these 'broken' clients.

param: bool $signThenEncrypt
return: $this

isSignThenEncrypt()   X-Ref

return: bool

reset()   X-Ref
Resets internal states.

return: $this

setWrapFullMessage($wrap)   X-Ref
Specify whether to wrap the entire MIME message in the S/MIME message.

According to RFC5751 section 3.1:
In order to protect outer, non-content-related message header fields
(for instance, the "Subject", "To", "From", and "Cc" fields), the
sending client MAY wrap a full MIME message in a message/rfc822
wrapper in order to apply S/MIME security services to these header
fields.  It is up to the receiving client to decide how to present
this "inner" header along with the unprotected "outer" header.

param: bool $wrap
return: $this

signMessage(Swift_Message $message)   X-Ref
Change the Swift_Message to apply the signing.

return: $this

getAlteredHeaders()   X-Ref
Return the list of header a signer might tamper.

return: array

smimeSignMessage(Swift_Message $message)   X-Ref
Sign a Swift message.


smimeEncryptMessage(Swift_Message $message)   X-Ref
Encrypt a Swift message.


copyHeaders(Swift_Message $fromMessage,Swift_Message $toMessage,array $headers = [])   X-Ref
Copy named headers from one Swift message to another.


copyHeader(Swift_Message $fromMessage, Swift_Message $toMessage, $headerName)   X-Ref
Copy a single header from one Swift message to another.

param: string $headerName

clearAllHeaders(Swift_Message $message)   X-Ref
Remove all headers from a Swift message.


wrapMimeMessage(Swift_Message $message)   X-Ref
Wraps a Swift_Message in a message/rfc822 MIME part.

return: Swift_MimePart

parseSSLOutput(Swift_InputByteStream $inputStream, Swift_Message $message)   X-Ref
No description

streamToMime(Swift_OutputByteStream $fromStream, Swift_Message $message)   X-Ref
Merges an OutputByteStream from OpenSSL to a Swift_Message.


parseStream(Swift_OutputByteStream $emailStream)   X-Ref
This message will parse the headers of a MIME email byte stream
and return an array that contains the headers as an associative
array and the email body as a string.

return: array

copyFromOpenSSLOutput(Swift_OutputByteStream $fromStream, Swift_InputByteStream $toStream)   X-Ref
No description



Generated: Tue May 19 15:55:14 2020 Cross-referenced by PHPXref 0.7.1