Merge pull request #4222 from edx/ahodges/documentation/DOC158

Ahodges/documentation/doc158

docs/en_us/course_authors/source/getting_started/glossary.rst

@@ -143,6 +143,18 @@ C
 D
 ****
 
+.. _Data Czar_g:
+
+**Data Czar**
+
+  A data czar is the single representative at a partner institution who is
+  responsible for receiving course data from edX, and transferring it securely
+  to researchers and other interested parties after it is received.
+
+  See `edX Research Guide`_.
+
+.. _edX Research Guide: http://edx.readthedocs.org/projects/devdata/en/latest/
+
 .. _Discussion Forum:
  
 **Discussion Forum**

docs/en_us/data/source/index.rst

@@ -11,6 +11,7 @@ This document is intended for researchers and data czars at edX partner institut
    preface.rst
    internal_data_formats/change_log.rst
    internal_data_formats/data_czar.rst
+   internal_data_formats/credentials.rst
    internal_data_formats/sql_schema.rst
    internal_data_formats/discussion_data.rst
    internal_data_formats/wiki_data.rst

docs/en_us/data/source/internal_data_formats/credentials.rst

+.. _Getting_Credentials_Data_Czar:
+
+####################################################
+Keys and Credentials for Data Transfers
+####################################################
+
+EdX transfers course data to the data czars at our partner institutions in
+regularly generated data packages. Data packages can only be accessed by a
+single contact at each university, referred to as the "data czar".
+
+The data czar who is selected at each institution sets up keys for securely
+transferring files from edX to the partner institution. Meanwhile, the
+Analytics team at edX sets up credentials so that the data czar can log in to
+the site where data packages are stored.
+
+ .. image:: ../Images/Data_Czar_Initialization.png
+  :alt: Flowchart of data czar creating public and private keys and sending the
+      public key to edX, and of edX creating data storage credentials and
+      encrypting those credentials with the public key before sending them to
+      the data czar
+
+After these steps for setting up credentials are complete, the data czar can
+download data packages on an ongoing basis.
+
+****************************************************************
+Data Czar: Create Keys for Encryption and Decryption
+****************************************************************
+
+To assure the security of data packages, the edX Analytics team encrypts all
+files before making them available to a partner institution. As a result, when
+you receive a data package (or other files) from the edX Analytics team, you
+must decrypt the files that it contains before you use them.
+
+The cryptograhpic processes of encrypting and decrypting data files require that you create a pair of keys: the public key in the pair is used to encrypt data, and the corresponding private key is used to decrypt any files that have been encrypted with the public key. 
+
+To create the keys needed for this encryption and decryption process, you use
+GNU Privacy Guard (GnuPG or GPG). Essentially, you install a cryptographic
+application on your local computer and supply your email address and a secret
+passphrase (a password). 
+
+.. note:: The email address that you supply when you create your keys must be your official email address at your edX partner institution.
+
+The result is the public key that you send to edX to use in encrypting data
+files for your institution, and the private key which you keep secret and use
+to decrypt the encrypted files that you receive. Creating these keys is a one-
+time process that you coordinate with your edX program manager. Instructions
+for creating the keys on Windows or Macintosh follow.
+
+For more information about GPG encryption and creating key pairs, see the
+`Gpg4win Compendium`_.
+
+.. _Gpg4win Compendium: http://www.gpg4win.org/doc/en/gpg4win-compendium.html
+
+=====================
+Create Keys: Windows
+=====================
+
+#. Go to the Gpg4win_ website and download the most recent version of Gpg4win.
+
+#. Install Gpg4win and then open the Kleopatra Gpg4win application. A wizard
+   presents a series of dialog boxes to collect information from you and 
+   generate your public key (called a certificate in Kleopatra).
+    
+   a. When you are prompted to specify the type of key pair you want, click
+      **Create personal OpenPGP key pair**.
+
+   b.  When you are prompted for your email address, be sure to enter your
+       official university or institution email address. EdX cannot use public
+       keys that are based on personal or other non-official email addresses to
+       encrypt data.
+
+   c. When you are prompted for a passphrase, enter a strong passphrase. Be
+      sure to remember your passphrase: you will use it to decrypt your data
+      packages.
+
+3. When Kleopatra presents the **Key Pair Successfully Created** dialog box,
+   click **Send Certificate by EMail** to send the public key (and only the
+   public key) to your edX program manager.
+
+#. Optionally, click **Make a Backup Copy of Your Key Pair** to store both of
+   the keys on a removable data storage device.
+
+.. important:: Do not reveal your passphrase, or share your private key, with anyone else.
+
+.. _Gpg4win: http://gpg4win.org/
+
+=======================
+Create Keys: Macintosh
+=======================
+
+#. Go to the `GPG Tools`_ website. Scroll down to the **GPG Suite** section of
+   the page and click **Download GPG Suite**.
+
+#. When the download is complete, click the .dmg file to begin the
+   installation.
+
+   When installation is complete, GPG Keychain Access opens a web page with
+   `First Steps`_ and a dialog box.
+
+#. Enter your name and email address. Be sure to enter your official university
+   or institution email address. EdX cannot use public keys that are based on
+   personal or other non-official email addresses to encrypt data.
+
+#. Click **Generate key**. A dialog box opens to prompt you for a passphrase.
+
+#. Enter a strong passphrase. Be sure to remember your passphrase: you will use
+   it to decrypt your data packages.
+
+#. To send only your public key to your edX program manager, click the key and
+   then click **Export**. A dialog box opens.
+
+  a. Specify a file name and location to save the file. 
+     
+  b. Make sure that **Format** is set to ASCII.
+  
+  c. Make sure that **Allow secret key export** is cleared.
+  
+  When you click **Save**, only the public key is saved in the resulting .asc
+  file. Do not share your private key with edX or any third party.
+
+7. Compose an e-mail message to your edX program manager. Attach the .asc
+   file that you saved in the previous step to the message, then send the
+   message.
+
+.. _GPG Tools: https://gpgtools.org/
+.. _First Steps: http://support.gpgtools.org/kb/how-to/first-steps-where-do-i-start-where-do-i-begin#setupkey
+
+****************************************************************
+EdX: Deliver Credentials for Accessing Data Storage
+****************************************************************
+
+The data packages that edX prepares for each partner organization are uploaded
+to the Amazon Web Service (AWS) Simple Storage Service (Amazon S3). The edX
+Analytics team creates an individual account to access this storage service for
+each data czar. The credentials for accessing this account are called an Access
+Key and a Secret Key.
+
+After the edX Analytics team creates these access credentials for you, they use
+the public encryption key that you sent your program manager to encrypt the
+credentials into a **credentials.csv.gpg** file. The edX Analytics team then
+sends the file to you as an email attachment.
+
+The **credentials.csv.gpg** file is likely to be the first file that you
+decrypt with your private GPG key. You use the same process to decrypt the data
+package files that you retrieve from Amazon S3. See `Decrypt an Encrypted
+File`_.
+
+ .. image:: ../Images/Access_AmazonS3.png
+  :alt: Flowchart of edX collecting files for the data package and then
+      encrypting, compressing, and uploading them to Amazon S3 and of data czar
+      decrypting access credentials, accessing S3 bucket, and then downloading,
+      extracting, and decrypting data package files
+
+.. _Decrypt an Encrypted File:
+
+****************************************************************
+Decrypt an Encrypted File
+****************************************************************
+
+To work with an encrypted .gpg file, you use the same GNU Privacy Guard program
+that you used to create your public/private key pair. You use your private key
+to decrypt the Amazon S3 credentials file and the files in your data packages.
+
+#. Save the encrypted file in an accessible location. 
+
+#. On a Windows computer, open Windows Explorer. On a Macintosh, open Finder.
+
+#. Navigate to the file and right-click it. 
+   
+#. On a Windows computer, select **Decrypt and verify**, then click
+   **Decrypt/Verify**. On a Macintosh, select **Services**, then click
+   **OpenPGP: Decrypt File**.
+
+#. Enter your passphrase. The GNU Privacy Guard program decrypts the file.
+   
+For example, when you decrypt the credentials.csv.gpg file the result is a
+credentials.csv file. Open the decrypted credentials.csv file to see that it
+contains your email address, your Access Key, and your Secret Key.
+
+ .. image:: ../Images/AWS_Credentials.png
+  :alt: A csv file, open in Notepad, with the Access Key value and the Secret Key value underlined
+
+****************************************************************
+Access Amazon S3 and Download Data Packages
+****************************************************************
+
+To connect to Amazon S3, you must have your decrypted credentials. You may want
+to have a third-party tool that gives you a user interface for managing files
+and transferring them from Amazon S3 to your network. Some data czars use
+applications like CloudBerry Explorer for Amazon S3, Bucket Explorer, or S3
+Browser. Alternatively, you can use the `AWS Command Line Interface`_.
+
+#. Select and install a third-party tool or interface to manage your S3
+   account.
+
+#. Open your decrypted credentials.csv file. This file contains your AWS Access
+   Key and your AWS Secret Key.
+
+#. Open the third-party tool. In most tools, you set up information about the
+   S3 account and then supply your Access Key and your Secret Key to connect to
+   that account. For more information, refer to the documentation for the tool
+   that you selected.
+
+#. Access Amazon S3 and navigate to the edX **course-data** bucket. For each
+   period that a data package is prepared for your organization, two files are
+   available.
+
+   Event tracking data is in a file named {date}-{organization}-tracking.tar.
+   Database data files are in a file named {organization}-{date}.zip.
+
+#. Download the files. These files can be very large, sometimes several
+   gigabytes in size.
+
+#. Extract the files from the compressed .tar and the .zip files. All of the
+   files that you extract are .gpg files.
+
+#. Use your private key to decrypt the .gpg files. See `Decrypt an Encrypted
+   File`_.
+
+.. _AWS Command Line Interface: http://aws.amazon.com/cli/
+

docs/en_us/data/source/internal_data_formats/data_czar.rst

@@ -14,8 +14,6 @@ information about edX data.
 
 * :ref:`Skills_Experience_Data_Czar`
 
-* :ref:`Getting_Credentials_Data_Czar`
-
 * :ref:`Resources_Information`
 
 At some institutions, only the data czar works on research projects that use
@@ -78,27 +76,6 @@ Technical Skills
 
 - Ability to validate the data and files received and distributed.
 
-.. _Getting_Credentials_Data_Czar:
-
-**************************************
-Getting Credentials for Data Czars
-**************************************
-
-The designated data czar at each institution works with an edX Program Manager
-to set up a public/private key pair for GNU Privacy Guard (GNUPG).
-
-* The edX Analytics team creates an account on the Amazon Web Service (AWS)
-  Simple Storage Service (S3), and provides the Program Manager with the
-  public key for account access.
-
-* When a data package is available, the data czar downloads it from S3 and
-  decrypts it using the private key.
-
-For detailed information on this procedure, see the `How Do I Get My Research
-Data Package?`_ article on the Open edX Analytics wiki.
-
-.. _How Do I Get My Research Data Package?: https://edx-wiki.atlassian.net/wiki/pages/viewpage.action?pageId=36044863
-
 .. _Resources_Information:
 
 **************************************
@@ -106,9 +83,9 @@ Resources and Information
 **************************************
 
 The edX Analytics team adds every data czar to a Google Group and mailing
-list_ called course-data.
+list called `course-data`_.
 
-.. _list: http://groups.google.com/a/edx.org/forum/#!forum/course-data
+.. _course-data: http://groups.google.com/a/edx.org/forum/#!forum/course-data
 
 EdX also hosts an `Open edX Analytics wiki`_ that is available to the
 public. The wiki provides links to the engineering roadmap, information about