From 1f30fac936a3b0905e736dd86e559e33caf036ac Mon Sep 17 00:00:00 2001 From: David Lawrence Date: Wed, 10 Aug 2011 18:26:03 -0400 Subject: Initial checkin of bmo/4.0 extensions. Still todo: port changes to core Bugzilla code --- .../en/default/pages/securemail/help.html.tmpl | 99 ++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 extensions/SecureMail/template/en/default/pages/securemail/help.html.tmpl (limited to 'extensions/SecureMail/template/en/default/pages/securemail') diff --git a/extensions/SecureMail/template/en/default/pages/securemail/help.html.tmpl b/extensions/SecureMail/template/en/default/pages/securemail/help.html.tmpl new file mode 100644 index 000000000..4e1a5c577 --- /dev/null +++ b/extensions/SecureMail/template/en/default/pages/securemail/help.html.tmpl @@ -0,0 +1,99 @@ +[%# + # The contents of this file are subject to the Mozilla Public + # License Version 1.1 (the "License"); you may not use this file + # except in compliance with the License. You may obtain a copy of + # the License at http://www.mozilla.org/MPL/ + # + # Software distributed under the License is distributed on an "AS + # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or + # implied. See the License for the specific language governing + # rights and limitations under the License. + # + # The Original Code is the Bugzilla SecureMail Extension. + # + # The Initial Developer of the Original Code is the Mozilla Foundation. + # Portions created by Mozilla are Copyright (C) 2008 Mozilla Foundation. + # All Rights Reserved. + # + # Contributor(s): Max Kanat-Alexander + # Gervase Markham + # Dave Lawrence + #%] + +[% PROCESS global/header.html.tmpl + title = "SecureMail Help" +%] + +[% terms.Bugzilla %] considers certain groups as "secure". If a [% terms.bug %] is in one of those groups, [% terms.Bugzilla %] +will not send unencrypted email about it. To receive encrypted email rather than just a "something changed" placeholder, you must provide either +a S/MIME or a GPG/PGP key on the SecureMail preferences tab.
+
+In addition, if you have uploaded a S/MIME or GPG/PGP key using the +SecureMail preferences tab, if you request your password to be reset, [% terms.Bugzilla %] will send the reset email encrypted and you will +be required to decrypt it to view the reset instructions. + +

S/MIME

+ +S/MIME Keys must be in PEM format - i.e. Base64-encoded text, with the first line containing BEGIN CERTIFICATE.

+ +

+S/MIME certificates can be obtained from a number of providers. You can get a free one from StartCom. +Once you have it, export it from your browser as a .p12 file and import it into your mail client. +You'll need to provide a password when you export - pick a strong one, and then back up the .p12 file somewhere safe.

+ +

+Then, you need to convert it to a .pem file. If you have OpenSSL installed, one way is as follows:

+ +

+openssl pkcs12 -in certificate.p12 -out certificate.pem -nodes

+ +

+Open the .pem file in a text editor. You can recognise the public key because it starts "BEGIN CERTIFICATE" and ends "END CERTIFICATE" and +has an appropriate friendly name (e.g. "StartCom Free Certificate Member's StartCom Ltd. ID"). It is not the section beginning +"BEGIN RSA PRIVATE KEY", and it is not any of the intermediate certificates or root certificates.

+ +

+Note: the .pem file has your private key in plaintext. Delete it once you have copied the public key out of it!

+ +

PGP

+ +PGP keys must be ASCII-armoured - i.e. text, with the first line containing BEGIN PGP PUBLIC KEY.

+ +

+If you already have your own PGP key in a keyring, skip straight to step 3. Otherwise:

+ +
    + +
  1. Install the GPG suite of utilities for your operating system, either using your package manager or downloaded from gnupg.org.

    + +

  2. Generate a private key.

    + +

    gpg --gen-key

    + +

    +You’ll have to answer several questions:

    + +

    +

      +
    • What kind and size of key you want; the defaults are probably good enough.
      • +
    • How long the key should be valid; you can safely choose a non-expiring key.
      • +
    • Your real name and e-mail address; these are necessary for identifying your key in a larger set of keys.
      • +
    • A comment for your key; the comment can be empty.
      • +
    • A passphrase. Whatever you do, don’t forget it! Your key, and all your encrypted files, will be useless if you do.
      • +
    + +

  3. Generate an ASCII version of your public key.

    + +

    gpg --armor --output pubkey.txt --export 'Your Name'

    + +

    Paste the contents of pubkey.txt into the SecureMail text field in [% terms.Bugzilla %]. + +

  4. Configure your email client to use your associated private key to decrypt the encrypted emails. For Thunderbird, you need the Enigmail extension.

    +
+ +

+Further reading: GPG Quickstart. + +[% PROCESS global/footer.html.tmpl %] + + -- cgit v1.2.3-24-g4f1b