Difference between revisions of "Document encryption"
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{TOCright}} __TOC__ | |
| + | Cryptography allows for additional document protection in OpenKM. With the cryptography extension, one can upload a new encrypted document, encrypt and decrypt an existing document, edit and check in an encrypted document and download and decrypt encryted documents. In order to make the cryptography process more secure, files are encrypted and decrypted on the local user computer by a signed applet. That means any networking file traffic is always with encrypted documents. | ||
| − | All Cryptography options are available | + | |
| + | All Cryptography options are available from the Tools menu: | ||
| Line 10: | Line 12: | ||
== Restrictions == | == Restrictions == | ||
* Cryptography is only allowed in taxonomy view. | * Cryptography is only allowed in taxonomy view. | ||
| − | * | + | * User must have write privileges on document and folder to perfom cyptography operations. |
| − | * For editing | + | * For editing purposes, the document should not be locked or checked out by another user. |
| − | |||
== Description of different icon options == | == Description of different icon options == | ||
* [[File:Crypt_doc_encrypt.png]] → Add new encrypted document | * [[File:Crypt_doc_encrypt.png]] → Add new encrypted document | ||
* [[File:Crypt_doc_encrypt_existing.png]] → Encrypt document | * [[File:Crypt_doc_encrypt_existing.png]] → Encrypt document | ||
| − | * [[File:Crypt_doc_checkout.png]] → Edit | + | * [[File:Crypt_doc_checkout.png]] → Edit encrypted document |
| − | * [[File:Crypt_doc_checkin.png]] → Checkin | + | * [[File:Crypt_doc_checkin.png]] → Checkin encrypted document |
* [[File:Crypt_doc_decrypt.png]] → Download decrypted document | * [[File:Crypt_doc_decrypt.png]] → Download decrypted document | ||
* [[File:Crypt_doc_decrypt_existing.png]] → Decrypt document | * [[File:Crypt_doc_decrypt_existing.png]] → Decrypt document | ||
| − | |||
== Add new encrypted document == | == Add new encrypted document == | ||
| − | First | + | First select some folder in the taxonomy where you have write privileges to upload a document. Next, select the [[File:Crypt_doc_encrypt.png]] '''Add new encrypted document''' menu option. An encrypt popup will appear. |
| Line 30: | Line 30: | ||
| − | Now simply put your cryptopharase twice, and select the file | + | Now simply put your cryptopharase twice, and select the file to encrypt by clicking on the '''select file''' button. After that the document will be encrypted locally with the cryptophrase and then uploaded to OpenKM. When the process is finished, a popup message will appear indicating a successful upload. |
| Line 36: | Line 36: | ||
| − | The OpenKM document explorer UI will be | + | The OpenKM document explorer UI will be refreshed and the newly uploaded document will appear with the cryptography icon [[File:Crypt.png]] indicating that it's an encrypted document. |
| Line 43: | Line 43: | ||
== Download decrypted document == | == Download decrypted document == | ||
| − | + | This operation downloads an encrypted document and decrypts it locally. First select some encrypted document in OpenKM. Then select the [[File:Crypt_doc_decrypt.png]] '''Download decrypted document''' option and a popup will appear for decrypting the remote OpenKM document. | |
| Line 49: | Line 49: | ||
| − | + | Next, put the decryptphrase and select the directory where you want to download the decrypted version of the OpenKM document. OpenKM will then download the encrypted document to the local computer, decrypt and save. After that an information popup will appear indicating that the document has been saved locally. | |
| Line 55: | Line 55: | ||
| − | == Edit | + | == Edit encrypted document == |
| − | In order | + | In order to edit an encrypted document, select the [[File:Crypt_doc_checkout.png]] '''Edit crypted document''' menu option. A decrypt popup will appear. |
| Line 62: | Line 62: | ||
| − | + | Next, put the decryptphrase and select the directory where you want to download the decrypted version of the OpenKM document. OpenKM will then download the encrypted document to the local computer, decrypt and save. After that an information popup will appear indicating that the document has been saved locally. | |
| Line 68: | Line 68: | ||
| − | The OpenKM document explorer UI will be | + | The OpenKM document explorer UI will be refreshed and the document will appear, marked for editing. |
| Line 74: | Line 74: | ||
| − | == | + | == Check-in encrypted document == |
| − | After making changes | + | After making changes to the local document ( decrypted using '''Edit encrypted document''' menu option ), you must upload a new document version to the OpenKM repository. First select the document that you want to upload to OpenKM. |
| Line 81: | Line 81: | ||
| − | Then | + | Then select the [[File:Crypt_doc_checkin.png]] '''Checkin encrypted document''' menu option. An encrypt popup will appear. |
| Line 87: | Line 87: | ||
| − | Now simply put your cryptopharase twice, and select the file | + | Now simply put your cryptopharase twice, and select the file by clicking on the '''select file''' button. After that, the document will be encrypted locally with the cryptophrase and then uploaded to OpenKM. When the process is finished, a popup message will appear indicating a successful upload. |
| Line 93: | Line 93: | ||
| − | The OpenKM document explorer UI will be | + | The OpenKM document explorer UI will be refreshed and the document will appear as the latest version. |
| + | |||
| + | |||
| + | [[File:Okm_user_guide_219.jpeg|center]] | ||
| + | |||
| + | |||
| + | {{Note|Cancelling checkin can be done with the normal '''cancel checkin''' button available in the toolbar}} | ||
| + | |||
| + | |||
| + | == Decrypt document == | ||
| + | Decrypt document will decrypt an encrypted document in OpenKM and will replace it will a decrypted version. For security reasons all previous encrypted document versions will be removed and replaced with the decrypted document. The encrypted document will be downloaded and decrypted locally, then uploaded to OpenKM and the version history purged. | ||
| + | |||
| + | |||
| + | First select an encrypted document in OpenKM. | ||
| Line 99: | Line 112: | ||
| − | + | Then select the [[File:Crypt_doc_decrypt_existing.png]] '''Decrypt document''' menu option. A decrypt popup will appear. | |
| + | |||
| + | |||
| + | [[File:Okm_user_guide_220.jpeg|center]] | ||
| + | |||
| + | Next, put the decryptphrase and select the '''Decrypt file''' button. The encrypted document will be downloaded and decrypted locally and then uploaded to OpenKM, and version history will be purged too. An information popup will appear indicating that the operation was done sucessfully. | ||
| + | |||
| + | |||
| + | [[File:Okm_user_guide_221.jpeg?|center]] | ||
| + | |||
| + | |||
| + | The OpenKM document explorer UI will be refreshed and the decrypted document will appear as the latest version, and with history purged. | ||
| + | |||
| + | |||
| + | [[File:Okm_user_guide_222.jpeg|center]] | ||
| + | |||
| + | |||
| + | ==Encrypt document == | ||
| + | Encrypt document will encrypt some unencrypted document in OpenKM and will replace it with the encrypted version. For security purposes all previous document versions will be removed and replaced with the encrypted document. The OpenKM document will be downloaded and encrypted locally, then uploaded to OpenKM and version history purged. | ||
| + | |||
| + | |||
| + | First select some unencrypted document in OpenKM. | ||
| + | |||
| + | |||
| + | [[File:Okm_user_guide_222.jpeg|center]] | ||
| + | |||
| + | |||
| + | Then select the [[File:Crypt_doc_encrypt_existing.png]] '''Encrypt document''' menu option. The document will be downloaded locally, encrypted, uploaded to OpenKM, and version history purged. | ||
| + | |||
| + | |||
| + | [[File:Okm_user_guide_223.jpeg|center]] | ||
| + | |||
| + | |||
| + | The OpenKM document explorer UI will be refreshed and the encrypted document will appear as the latest version, and with history purged. | ||
| + | |||
| + | |||
| + | [[File:Okm_user_guide_224.jpeg|center]] | ||
| + | |||
[[Category: User Guide]] | [[Category: User Guide]] | ||
Latest revision as of 17:29, 29 November 2011
Cryptography allows for additional document protection in OpenKM. With the cryptography extension, one can upload a new encrypted document, encrypt and decrypt an existing document, edit and check in an encrypted document and download and decrypt encryted documents. In order to make the cryptography process more secure, files are encrypted and decrypted on the local user computer by a signed applet. That means any networking file traffic is always with encrypted documents.
All Cryptography options are available from the Tools menu:
Restrictions
- Cryptography is only allowed in taxonomy view.
- User must have write privileges on document and folder to perfom cyptography operations.
- For editing purposes, the document should not be locked or checked out by another user.
Description of different icon options
-
→ Add new encrypted document -
→ Encrypt document -
→ Edit encrypted document -
→ Checkin encrypted document -
→ Download decrypted document -
→ Decrypt document
Add new encrypted document
First select some folder in the taxonomy where you have write privileges to upload a document. Next, select the 
Add new encrypted document menu option. An encrypt popup will appear.
Now simply put your cryptopharase twice, and select the file to encrypt by clicking on the select file button. After that the document will be encrypted locally with the cryptophrase and then uploaded to OpenKM. When the process is finished, a popup message will appear indicating a successful upload.
The OpenKM document explorer UI will be refreshed and the newly uploaded document will appear with the cryptography icon 
indicating that it's an encrypted document.
Download decrypted document
This operation downloads an encrypted document and decrypts it locally. First select some encrypted document in OpenKM. Then select the 
Download decrypted document option and a popup will appear for decrypting the remote OpenKM document.
Next, put the decryptphrase and select the directory where you want to download the decrypted version of the OpenKM document. OpenKM will then download the encrypted document to the local computer, decrypt and save. After that an information popup will appear indicating that the document has been saved locally.
Edit encrypted document
In order to edit an encrypted document, select the 
Edit crypted document menu option. A decrypt popup will appear.
Next, put the decryptphrase and select the directory where you want to download the decrypted version of the OpenKM document. OpenKM will then download the encrypted document to the local computer, decrypt and save. After that an information popup will appear indicating that the document has been saved locally.
The OpenKM document explorer UI will be refreshed and the document will appear, marked for editing.
Check-in encrypted document
After making changes to the local document ( decrypted using Edit encrypted document menu option ), you must upload a new document version to the OpenKM repository. First select the document that you want to upload to OpenKM.
Then select the 
Checkin encrypted document menu option. An encrypt popup will appear.
Now simply put your cryptopharase twice, and select the file by clicking on the select file button. After that, the document will be encrypted locally with the cryptophrase and then uploaded to OpenKM. When the process is finished, a popup message will appear indicating a successful upload.
The OpenKM document explorer UI will be refreshed and the document will appear as the latest version.
 |
Cancelling checkin can be done with the normal cancel checkin button available in the toolbar |
Decrypt document
Decrypt document will decrypt an encrypted document in OpenKM and will replace it will a decrypted version. For security reasons all previous encrypted document versions will be removed and replaced with the decrypted document. The encrypted document will be downloaded and decrypted locally, then uploaded to OpenKM and the version history purged.
First select an encrypted document in OpenKM.
Then select the 
Decrypt document menu option. A decrypt popup will appear.
Next, put the decryptphrase and select the Decrypt file button. The encrypted document will be downloaded and decrypted locally and then uploaded to OpenKM, and version history will be purged too. An information popup will appear indicating that the operation was done sucessfully.
The OpenKM document explorer UI will be refreshed and the decrypted document will appear as the latest version, and with history purged.
Encrypt document
Encrypt document will encrypt some unencrypted document in OpenKM and will replace it with the encrypted version. For security purposes all previous document versions will be removed and replaced with the encrypted document. The OpenKM document will be downloaded and encrypted locally, then uploaded to OpenKM and version history purged.
First select some unencrypted document in OpenKM.
Then select the 
Encrypt document menu option. The document will be downloaded locally, encrypted, uploaded to OpenKM, and version history purged.
The OpenKM document explorer UI will be refreshed and the encrypted document will appear as the latest version, and with history purged.
