-
Notifications
You must be signed in to change notification settings - Fork 41
Browser: add a section about certificates #459
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nephros
wants to merge
1
commit into
sailfishos:master
Choose a base branch
from
nephros:browser-cert
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,48 @@ grand_parent: Core Areas and APIs | |
| layout: default | ||
| --- | ||
|
|
||
| ## The Browser Profile | ||
|
|
||
| The Sailfish OS Browser stores its profile at `${HOME}/.local/share/org.sailfishos/browser/.mozilla/` | ||
|
|
||
| Some of the operations for configuring this profile given in the official | ||
| Mozilla Documentation are supported. | ||
|
|
||
| Such as: | ||
|
|
||
| ### Adding TLS Certificates | ||
|
|
||
| User-specific CA or Client TLS certificates can be added to the user-specific certificate store: | ||
|
|
||
| For a CA Certificate: | ||
|
|
||
| ``` | ||
| export CA_NAME="My Root Authority" | ||
| export PEM=/path/to/ca.pem | ||
| export MOZILLA_PROFILE="${HOME}/.local/share/org.sailfishos/browser/.mozilla/" | ||
| certutil -A -n "$CA_NAME" -t "TC,," -d "${MOZILLA_PROFILE} -i ${PEM} | ||
| ``` | ||
|
|
||
| For a Client Certificate: | ||
|
|
||
| Usually, client certificates come in a `.pfx` file. | ||
| To be able to import it into the Browser, they must first be converted into PEM format. | ||
| Refer to the OpenSSL documentation on how to do the conversion. | ||
|
|
||
| Once you have the certificate in PEM format, import it as: | ||
| ``` | ||
| export CRT_NAME="My Client Cert" | ||
| export PEM=/path/to/client.pem | ||
| export MOZILLA_PROFILE="${HOME}/.local/share/org.sailfishos/browser/.mozilla/" | ||
| certutil -A -n "$CRT_NAME" -t "Pu,," -d "${MOZILLA_PROFILE} -i ${PEM} | ||
| ``` | ||
|
|
||
| Note the differences in the parameter to the `-t` option! | ||
|
|
||
| The `certutil` utility is provided by the `nss-tools` package. | ||
|
|
||
| **Note:** in Sailfish OS releases prior to version 4.x, the Browser profile was stored in ` -d ${HOME}/.mozilla/mozembed/` | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this relevant anymore? |
||
|
|
||
| ## Console API messages | ||
|
|
||
| - EMBED_CONSOLE=1 environment variable be used to log messages to terminal / journal | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there reason to make these now first items in the page? Could think for browser development the logging and building type of things would still be more important.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see what you mean. This is more a user guide vs. development documentation.
Would you be open to reorganize the Browser-related pages into e.g.
So it is clearer what the pages are for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well at the moment, or even with these changes, the content here is hardly a user guide. If we wanted such for Browser, think that should go then somewhere around these https://docs.sailfishos.org/Support/Help_Articles/ - though these certificate things could be too low level there. Generally user guide should rather document what's available on the UI.
Fwiw, elsewhere this page is now referred as "browser development page" - https://docs.sailfishos.org/Reference/Core_Areas_and_APIs/Browser/
Is the motivation for adding these texts as app user (not developer) working around not having a direct UI for it?