Merge pull request #3 from Start9Labs/feature/ssl

Feature/ssl

source/_static/default.css

@@ -70,7 +70,12 @@ h1, h2 {
     }
 }
 
-ul .current li .current {
+
+a:active {
+    text-decoration: none;
+}
+
+ul.current > .current .active > a.current {
     text-decoration: underline #f8f8ff;
 }
 

source/user-manuals/embassyos/general/index.rst

@@ -16,5 +16,5 @@ Features
   developer-options/index
   power
   notifications
-  ssl
+  secure-lan/index
   forgot-password

source/user-manuals/embassyos/general/secure-lan/browser.rst

@@ -0,0 +1,87 @@
+.. _browsers:
+
+*******
+Browser
+*******
+
+.. warning:: Make sure you have completed setup on your :ref:`device <ssl-setup>` before continuing!
+
+Brave
+=====
+
+1. Navigate to your Brave Settings in a new tab.
+
+2. On the left hand sidebar, select ``Additional Settings > Privacy and Security``.
+
+3. Add the bottom of the section, select "Manage Certificates".
+
+.. figure:: /_static/images/ssl/browser/brave_security_settings.png
+  :width: 90%
+  :alt: Brave security settings
+
+  Brave privacy and security settings page
+
+4. If you see a trusted “Embassy Local Root CA”, open a new tab to apply the certificate. If this does not work, quit and restart Brave.
+
+5. If you do not see a trusted “Embassy Local Root CA” certificate in the list, ensure the certificate is properly set up on your computer system.
+
+.. figure:: /_static/images/ssl/browser/brave_view_certs.png
+  :width: 90%
+  :alt: Brave manage certs
+
+  Brave Manage Certificates sub-menu on MacOS
+
+6. Obtain the LAN address provided in the Setup App and enter it in a new tab.
+
+7. You can now securely navigate to your Embassy over HTTPS!
+
+8. Additionally, you can start a Brave private window with Tor to visit the Tor address over HTTPS (unnecessary in principle, but will circumvent annoying browser warnings).
+
+Chrome
+======
+
+1. Once you have followed the steps to setup your device, open a new tab to apply the certificate. If this does not work, quit and restart Chrome.
+
+2. Obtain the LAN address provided in the Setup App and enter it in the URL bar.
+
+3. You can now securely navigate to your Embassy over HTTPS!
+
+Firefox
+========
+
+1. Navigate to your Firefox Settings in a new tab.
+
+2. Select “Privacy and Security” from the left hand navigation menu.
+
+3. Scroll all the way to the bottom of the page and select “View Certificates”.
+
+.. figure:: /_static/images/ssl/browser/firefox_security_settings.png
+  :width: 90%
+  :alt: Firefox security settings
+
+  Firefox privacy and security settings page
+
+4. Click “Import” and open the downloaded ``Embassy Local Root CA.crt`` file on your device. If you cannot find this, make sure you completed the :ref:`device setup steps <ssl-setup>`.
+
+5. When prompted, check “Trust this CA to identity websites” and select “OK”.
+
+.. figure:: /_static/images/ssl/browser/firefox_security_settings.png
+  :width: 90%
+  :alt: Firefox import cert
+
+  Firefox import certificate page
+
+6. Ensure the “Embassy Local Root CA” exists under “Start9 Labs”.
+
+7. Click “OK” to save.
+
+8. Open a new tab in Firefox to apply the changes. If this does not work, quit and restart Firefox.
+
+9. Navigate to the LAN address provided in the Setup App.
+
+10. You can now securely navigate to your Embassy over HTTPS!
+
+Safari
+======
+
+Once you have completed the steps to install a SSL certificate on your device, simply open a new tab to apply the changes. If this does not work, quit and restart Safari. You can now security navigate to the LAN address for your Embassy!

source/user-manuals/embassyos/general/secure-lan/desktop.rst

@@ -0,0 +1,196 @@
+********
+Desktop
+********
+
+MacOS
+=====
+
+1. Copy the Tor address from the Setup App. It is safe to message this address to yourself so that you can paste it in a browser.
+
+2. Navigate to a :ref:`Tor enabled browser <connecting>`.
+
+3. Your browser might display a warning screen. You can typically navigate to ``Advanced > Accept the risk and continue``.
+
+4. Allow the page to load with your Tor address over HTTP. Using HTTPS is less performant and unnecessary because Tor v3 is self authenticating.
+
+5. Login to Ambassador UI with the master password you created in the Setup App.
+
+6. Navigate to the “Embassy” tab in the menu.
+
+7. Find the section entitled “Secure LAN Setup”.
+
+.. figure:: /_static/images/embassy_lan_setup.png
+  :width: 90%
+  :alt: Secure LAN setup menu item
+
+  Select the "Secure LAN Setup" menu item
+
+8. Select the "SSL Certificate" sub menu. This will prompt a download to save the certificate file to your machine.
+
+.. figure:: /_static/images/secure_lan_setup_page.png
+  :width: 90%
+  :alt: Secure LAN setup page
+
+  Select the "SSL Certificate" sub menu
+
+9.  Select the option to open your key with Keychain Access. If you choose to save file, double click on it once downloaded.
+
+.. figure:: /_static/images/secure_lan_setup_prompt.png
+  :width: 90%
+  :alt: Secure LAN setup prompt
+
+  Open with "Keychain Access" and select "OK"
+
+10. Enter your computer password when prompted. It will be imported into your computer’s keychain.
+
+.. figure:: /_static/images/ssl/macos/certificate_untrusted.png
+  :width: 90%
+  :alt: Keychain access import menu
+
+  Keychain access import menu
+
+If the keychain console did not open, press ``Command + spacebar`` and type “Keychain Access”, and hit enter to open it.
+
+11. Navigate to the “System” tab and find the certificate entitled “Embassy Local Root CA”.
+
+12. Double click on this certificate. A second window will pop up.
+
+13. Open the “Trust” dropdown and select “Always Trust” from the dropdown next to “when using this certificate”.
+
+.. figure:: /_static/images/ssl/macos/always_trust.png
+  :width: 90%
+  :alt: Keychain submenu
+
+  Select "Always trust" under SSL dropdown for Embassy Local CA
+
+14. Close this window and enter your password to apply the settings.
+
+15. The “Embassy Local Root CA” cert will now read “This certificate is marked as trusted for all users” in Keychain Access.
+
+.. figure:: /_static/images/ssl/macos/certificate_trusted.png
+  :width: 90%
+  :alt: Keychain menu trusted certificate
+
+  Trusted Embassy Local CA certificate
+
+16. Navigate to your desired browser to import this certificate and follow the steps for :ref:`supported browsers <browsers>`.
+
+Windows
+=======
+
+1. Copy the Tor address from the Setup App. It is safe to message this address to yourself so that you can paste it in a browser.
+
+2. Navigate to a :ref:`Tor enabled browser <connecting>`.
+
+3. Your browser might display a warning screen. You can typically navigate to ``Advanced > Accept the risk and continue``.
+
+4. Allow the page to load with your Tor address over HTTP. Using HTTPS is less performant and unnecessary because Tor v3 is self authenticating.
+
+5. Login to Ambassador UI with the master password you created in the Setup App.
+
+6. Navigate to the “Embassy” tab in the menu.
+
+7. Find the section entitled “Secure LAN Setup”.
+
+.. figure:: /_static/images/ssl/windows/windows_embassy_menu.png
+  :width: 90%
+  :alt: Secure LAN setup menu item
+
+  Select the "Secure LAN Setup" menu item
+
+8. Select the "SSL Certificate" sub menu. This will prompt a download to save the certificate file to your machine.
+
+.. figure:: /_static/images/ssl/windows/windows_lan_page.png
+  :width: 90%
+  :alt: Secure LAN setup page
+
+  Select the "SSL Certificate" sub menu download icon
+
+9.  Select the option to save the ``Embassy Local CA.crt`` file. 
+
+.. figure:: /_static/images/ssl/windows/windows_download_cert.png
+  :width: 90%
+  :alt: Secure LAN setup prompt
+
+  "Save file" when Opening Embassy Local CA.crt
+
+10. On your computer, right-click the “Start” menu and select “Run”.
+
+11. Type in “mmc” and click “OK”. When prompted on the “User Account Control” window, select “Yes” to allow this program to run.
+
+.. figure:: /_static/images/ssl/windows/1_windows_mmc.png
+  :width: 90%
+  :alt: Windows MMC
+
+  Access the Windows Management Console
+  
+12. When the Management Console opens, navigate to ``File > Add/Remove Snap-in``.
+
+.. figure:: /_static/images/ssl/windows/2_windows_console_root.png
+  :width: 90%
+  :alt: Windows Console Root
+
+  Add Snap-in from Console Root
+
+13. Select “Certificates” in the left side menu, then “Add”. This will open another window.
+
+.. figure:: /_static/images/ssl/windows/3_windows_add_certificates.png
+  :width: 90%
+  :alt: Add Certificates
+
+  Add Certificates to selected snap-ins
+
+14. Select “Computer account” and click “Next. Leave defaulted options on the next screen and click “Finish”.
+
+15. When you return to the “Add or Remove Snap-ins” page, ensure “Certificates (Local Computer)” exists under “Console Root” in the “Selected snap-ins” section, then click “OK”.
+
+.. figure:: /_static/images/ssl/windows/4_windows_selected_snapin.png
+  :width: 90%
+  :alt: Snap-in Selected
+
+  Certificates (Local Computer) is selected as snap-in
+
+16. In the left hand menu of the Management Console, navigate to Certificates (Local Computer) > Trusted Root Certification Authorities > Certificates.
+
+.. figure:: /_static/images/ssl/windows/5_windows_trusted_certificate_menu.png
+  :width: 90%
+  :alt: Certificates in Management Console
+
+  Access Certificates in Management Console
+
+17. Right click on “Certificates”, then select ``All Tasks > Import``.
+
+.. figure:: /_static/images/ssl/windows/6_windows_import_cert.png
+  :width: 90%
+  :alt: Import certificate
+
+  Select "Import" from Certificates sub-menu
+
+18. Click “Next” on the first page of the Certificate Import Wizard, then browse to the location where you saved the downloaded certificate and click “Open”.
+
+.. figure:: /_static/images/ssl/windows/7_windows_import_cert_wizard.png
+  :width: 90%
+  :alt: Import cert wizard
+
+  Add downloaded certificate int he Certificate Import Wizard
+
+19. On the “Certificate Store” window, ensure that it says “Trusted Root Certificate Authorities” and click “Next”.
+
+20. Select “OK” when the import is successful.
+
+21. Verify the Embassy Local Root CA certificate is in the “Certificates” folder.
+
+.. figure:: /_static/images/ssl/windows/8_windows_successful_cert_install.png
+  :width: 90%
+  :alt: Successful cert install
+
+  Embassy Local Root CA imported into Certificate folder
+
+22. You can save the settings to the console if desired or cancel.
+
+23. Navigate to your desired browser to import this certificate and follow the steps for :ref:`supported browsers <browsers>`.
+
+Linux
+=====
+
+Please reach out to `@ProofOfKeags <http://twitter.com/ProofOfKeags>`_ on `Telegram <https://t.me/start9_labs>`_ if you would like assistance setting up SSL Certificates in this environment.

source/user-manuals/embassyos/general/secure-lan/index.rst

@@ -0,0 +1,38 @@
+.. _ssl-setup:
+
+****************
+Secure LAN Setup
+****************
+
+EmbassyOS has ability to securely access your Embassy over HTTPS from any browser in addition to the already secure option of communicating over Tor. This method of connecting is faster when on the same Local Area Network (LAN). This is accomplished by HTTPS using the OpenSSL protocol. Your Embassy becomes a Certificate Authority and uses its root certificate to generate a self-signed cert for you to import on your devices.
+
+The following guides will take you through the steps to install and trust the SSL certificate generated from your Embassy.
+
+First, determine your current version of EmbassyOS from the menu  at ``Embassy > About > EmbassyOS Version``.
+
+.. figure:: /_static/images/embassy_version.png
+  :width: 90%
+  :alt: EmbassyOS version view
+
+  How to view EmbassyOS version
+
+
+.. warning:: 
+  For EmbassyOS versions ``<0.2.5``, please follow the setup instructions on this `blog post <https://medium.com/@start9labs/embassy-https-certificate-setup-8cd873d7075c>`_.
+
+  For EmbassyOS versions ``>=0.2.5``, continue below.
+
+Complete the setup for your device operating system:
+
+.. toctree::
+  :maxdepth: 2
+
+  desktop
+  mobile
+
+Next, complete the setup for your desired browser. This guide currently covers:
+
+.. toctree::
+  :maxdepth: 2
+
+  browser

source/user-manuals/embassyos/general/secure-lan/mobile.rst

@@ -0,0 +1,88 @@
+******
+Mobile
+******
+
+
+iOS
+====
+
+1. Navigate back to the `Start9 Setup App <https://apps.apple.com/us/app/start9-setup-app/id1528125889>`_. 
+
+2. Select your claimed Embassy to view the setup results.
+
+3. Find the "Advanced" menu item at the bottom of the Setup App screen.
+
+.. figure:: /_static/images/ssl/mobile/ssl_setup_app_complete.png
+  :width: 90%
+  :alt: Setup app complete
+
+  Completed Setup App screen
+
+4. Select the "Embassy Local Root CA" menu item. Clicking this will prompt you to “Save to device”.
+
+.. figure:: /_static/images/ssl/mobile/ssl_setup_app_advanced.png
+  :width: 90%
+  :alt: Setup app advanced menu
+
+  Setup App advanced menu
+
+.. note:: At this point, you may see a yellow messaging indicating you need to reclaim your Embassy to activate this feature. Proceed with the recommendation.
+
+5. You will be directed to a page in Safari indicating next steps and that the profile has been successfully downloaded. Be sure to complete all steps in this process. These steps are also outlined below.
+
+.. figure:: /_static/images/ssl/mobile/ssl_certificate_install_page.png
+  :width: 90%
+  :alt: Certificate install page
+
+  Select "Allow" on the certificate install page
+
+6. Go to Settings on your iOS device.
+
+.. figure:: /_static/images/ssl/mobile/ssl_ipad_general_settings.png
+  :width: 90%
+  :alt: General settings
+
+  General settings
+
+7. Navigate to ``General > Profile(s) > Downloaded Profile > Install``.
+
+.. figure:: /_static/images/ssl/mobile/ssl_ipad_profiles.png
+  :width: 90%
+  :alt: Profiles
+
+  Profiles view
+
+.. figure:: /_static/images/ssl/mobile/ssl_ipad_install_profile.png
+  :width: 90%
+  :alt: Install profile
+
+  Select "Install" for Embassy Local Root CA
+
+8. Select “yes” to any warning prompts.
+
+9. Next, navigate to ``General > About > Certificate Trust Settings``.
+
+.. figure:: /_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.png
+  :width: 90%
+  :alt: Certificate trust settings
+
+  Select Certificate Trust Settings (scroll all the way down)
+
+10. Enable full trust for root certificates.
+
+.. figure:: /_static/images/ssl/mobile/ssl_ipad_cert_trust.png
+  :width: 90%
+  :alt: Enable full trust
+
+  Toggle to enable full trust for root certificates. "Continue" when warning prompts.
+
+11. Test that this process worked successfully by navigating to the LAN address provided in the Setup App. You should no longer see warnings about the security of this site in your browser. We recommend using Start9’s own `Consulate browser <https://apps.apple.com/us/app/consulate/id1528124570>`_ for a faster and better experience.
+
+
+Android
+=======
+
+Unfortunately, Android devices do not yet natively support mDNS, which is used to access LAN addresses on a mobile device browser. As a result, you cannot yet access your LAN address from the browser on Android. We are tracking this issue `here <https://issuetracker.google.com/issues/140786115>`_, please star it to get more attention from the development team!
+
+We are also working on the `Consulate <https://medium.com/@start9labs/announcing-the-consulate-browser-76d94a8599cb>`_ for Android, which will enable this feature by default and allow you to bookmark your LAN address for efficient access to your Embassy over HTTPS.
+In the meantime, you can access your Embassy on Android using the `Tor Browser <https://www.torproject.org/download/>`_.

source/user-manuals/embassyos/general/ssl.rst

@@ -1,7 +0,0 @@
-.. _ssl-setup:
-
-*********
-SSL Setup
-*********
-
-Please follow the setup instructions `here <https://medium.com/@start9labs/embassy-https-certificate-setup-8cd873d7075c>`_.