diff options
| author | Saturneric <[email protected]> | 2022-03-13 09:37:16 +0000 |
|---|---|---|
| committer | Saturneric <[email protected]> | 2022-03-13 09:37:16 +0000 |
| commit | 943313a42433e6fa346365232bfd65585b2c0cd1 (patch) | |
| tree | 19ff9f912c8af78454f01fedb8d1144573d0f01a | |
| parent | <fix>(ci): Fix code inspection build issues (diff) | |
| parent | <doc>(project): update README.md. (diff) | |
| download | GpgFrontend-943313a42433e6fa346365232bfd65585b2c0cd1.tar.gz GpgFrontend-943313a42433e6fa346365232bfd65585b2c0cd1.zip | |
<refactor>(doc): merge dev/doc/2.0.5
26 files changed, 818 insertions, 388 deletions
@@ -1,4 +1,4 @@ -<img width="100" height="100" align="right" src="https://github.com/saturneric/Blob/blob/master/logos/icon.png?raw=true" alt="ICON"/> +<img width="100" height="100" align="right" style="position: absolute;right: 0;padding: 12px;top:12px;" src="https://github.com/saturneric/Blob/blob/master/logos/icon.png?raw=true" alt="ICON"/> # GpgFrontend @@ -11,79 +11,115 @@ [](https://github.com/saturneric/GpgFrontend/actions/workflows/release.yml) GpgFrontend is a Free, Open Source, Powerful, Easy-to-Use, Compact, Cross-Platform [OpenPGP](https://www.openpgp.org/) -Crypt Tool. +Crypt Tool. Also, it's one of the excellent GUI Frontends for Modern [GnuPG](https://www.gnupg.org/) (gpg). -By using GpgFrontend, you can quickly encrypt and decrypt text or files. Or at the same time as the above operations, -you can add your own signature to let others know that this document or this paragraph of text was issued by you. -Please **take the initiative to protect privacy in your own hands**, instead of relying on servers and algorithms -provided by large companies. Please use this tool to transmit or store information that you regard as very precious. You -can also use it to securely guarantee the authenticity of your information. +By using GpgFrontend, you can quickly encrypt and decrypt text or files. You can also digitally sign your text or files. +**GpgFrontend does not need to depend on any server, therefore it may be one of the last lines of defense in protecting +your privacy.** Please use this tool to transmit or store information that you regard as very precious. You can also use +it to guarantee the authenticity of your information. -GpgFrontend [supports languages](#languages-support) that are widely used in most countries and regions around the +[Languages Supported](#languages-support) by GpgFrontend that are widely used in most countries and regions around the world, including English, Chinese, French, Russian, German, Spanish, Portuguese, Arabic, etc. **Notice:** GpgFrontend does not provide an embedded [gnupg](https://gnupg.org/) (gpg) binary and needs to be installed by the user. **This is to ensure safety and avoid code or binary files involved in encryption and decryption being implanted in the back-door during the delivery process.** -If you find this tool useful and promising, welcome to encourage me through STAR this project. Thanks! +GpgFrontend is permanently free, and you can also "donate" it through the STAR project. Thanks! -[>> Quick Start <<](#quick-start) | +[>> Overview <<](https://www.gpgfrontend.pub/#/overview) | [>> Code & Binary Security <<](https://gpgfrontend.pub/#/about/code-binary-verify) +| [>> Track Development <<](https://global.git.codesdream.com/) -<div align="center"> <img src="https://github.com/saturneric/Blob/blob/master/screenshots/main-ubuntu.png?raw=true" alt="Ubuntu Main Screenshot"/> -</div> ---- ## Table of Contents - [Usage](#usage) - - [Quick Start](#quick-start) -- [Document](#document) -- [Build](#build) +- [User Manual](#user-manual) +- [Build Source Code](#build-source-code) - [Languages Support](#languages-support) -- [Contributing & Bugs Report](#contributing--bugs-report) - - [Contract](#contract) - - [Maintainers](#maintainers) +- [Contract](#contract) - [Licenses](#LICENSES) ## Usage -### Quick Start +Here are some common usages to help you understand what GpgFrontend does and where it comes in handy. The interface +presented may not be exactly the same as the latest stable release. -Here are some common usages to help you understand what GpgFrontend does and where it comes in handy. The interface presented may not be exactly the same as the latest stable release. - -#### Fast Text Encryption +### Text Encryption Encryption can be done in just a few clicks.  -#### Fast Text Decryption +### Text Decryption I want to see what you wrote right away.  -#### Fast File Encryption & Sign +### File Encryption & Sign What about files?  -## Document +## User Manual + +GpgFrontend provides detailed documentation on his main features. If you want to know how to install with it, please +read the [User Manual](https://www.gpgfrontend.pub/#/quick-start) instead of README. + +## Build Source Code + +### For Ubuntu 20.04 + +Install and compile dependencies. + +```shell +$ sudo apt-get update +$ sudo apt-get -y install gettext texinfo git ninja-build cmake +$ sudo apt-get -y install gcc g++ build-essential binutils autoconf automake +$ sudo apt-get -y libconfig++-dev libboost-all-dev qt5-default +$ sudo apt-get -y install gpg # If you need to run directly after building. +``` + +Clone the latest stable version code for users around the world. + +```shell +$ git clone --recurse-submodules https://github.com/saturneric/GpgFrontend.git +``` -GpgFrontend provides detailed documentation on his main features. If you want to know how to install with it, please read the [Quick Start](https://www.gpgfrontend.pub/#/quick-start) instead of README. +如果你在中国大陆，可以使用这个仓库 -## Build +```shell +$ git clone --recurse-submodules https://git.codesdream.com/GpgFrontend.git +``` -The tutorial for building the software will be released soon. Before the relevant documents are released, you can refer to the project-related Github Action file if you know it. +Build the code and make the deb package. + +```shell +$ cd GpgFrontend +$ mkdir build && cd build +$ cmake -G Ninja -DCMAKE_BUILD_TYPE="Release" -DGENERATE_LINUX_INSTALL_SOFTWARE=ON .. +$ ninja +$ ninja package +``` + +Build the code separately for debug. + +```shell +$ cd GpgFrontend +$ mkdir build && cd build +$ cmake -G Ninja -DCMAKE_BUILD_TYPE="Debug" .. +$ ninja +$ ./release/GpgFrontend # run the program +``` ## Languages Support -The supported languages are listed here. Some languages use machine translation and have not been verified. If you want to join translation and verification work, please refer to -the [here](https://gpgfrontend.pub/#/translate-interface). +The supported languages are listed here. Some languages use machine translation and have not been verified. If you want +to join translation and verification work, please refer to [here](https://gpgfrontend.pub/#/translate-interface). ### Supported Languages @@ -92,7 +128,8 @@ the [here](https://gpgfrontend.pub/#/translate-interface). 'hr_HR', 'cs_CZ', 'da_DK', 'nl_NL', 'et_EE', 'fa_IR', 'fi_FI', 'fr_CA', 'he_IL', 'id_ID', 'lt_LT', 'De_AT', 'De_CH', 'El_GR', 'Es_MX', 'Iw_IL', 'UK_UA' -Notice: The verification may not be complete and rigorous. +Notice: Most translations are generated by Google's automatic translation machine.If you find that a certain translation +is wrong, you are welcome to join the translation work to provide a more suitable human translation. ## Contract @@ -100,13 +137,14 @@ Please refer to [here](https://www.gpgfrontend.pub/#/contract) for my contact de ### Contributing & Bugs Report -Feel free to dive in! [Open an issue](https://github.com/saturneric/GpgFrontend/issues/new) or submit PRs. +Feel free to dive in! [Open an issue](https://github.com/saturneric/GpgFrontend/issues/new) or submit PRs if you prefer +to use GitHub. For anonymous users, Git patches can be delivered by [mail](mailto:[email protected]). ### Project Maintainer -[@Saturneric](https://github.com/saturneric). +[@Saturneric](https://github.com/saturneric) -## LOGO +### Project's LOGO  @@ -118,17 +156,14 @@ GpgFrontend itself is licensed under the [GPLv3](COPYING). ### Dependency -There are some libraries and binary included in the zip-file which (may) have different licenses, for more information check their homepages. You can also obtain the sources from there. +There are some libraries and binary included in the zip-file which (may) have different licenses, for more information +check their homepages. You can also obtain the sources from there. gnupg: https://gnupg.org gpgme: https://gnupg.org/software/gpgme/index.html -gpg4usb: https://www.gpg4usb.org - -QT 5.15(opensource): https://www.qt.io - -QT 5.12(opensource): https://www.qt.io +Qt(opensource): https://www.qt.io MSYS2: https://www.msys2.org @@ -138,7 +173,15 @@ AppImage: https://appimage.org JSON for Modern C++: https://github.com/nlohmann/json -Application +SMTP Client for Qt (C++): https://github.com/bluetiger9/SmtpClient-for-Qt + +Qt-AES: https://github.com/saturneric/Qt-AES + +vmime: https://www.vmime.org/ + +MacOS Application Bundles: [Link](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html#//apple_ref/doc/uid/10000123i-CH101-SW1) -The icons of this software use materials from [Alibaba Iconfont](!https://www.iconfont.cn/). The Alibaba vector icon library is free to use. The icons in the free library aren't registered as trademarks. There is no copyright issue involved and can be used commercially. +The icons of this software use materials from [Alibaba Iconfont](!https://www.iconfont.cn/). The Alibaba vector icon +library is free to use. The icons in the free library aren't registered as trademarks. There is no copyright issue +involved and can be used commercially. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 24c74fb0..00000000 --- a/SECURITY.md +++ /dev/null @@ -1,19 +0,0 @@ -# Security Policy - -## Supported Versions - -Use this section to tell people about which versions of your project are -currently being supported with security updates. - -| Version | Supported | -| ------- | ------------------ | -| 2.0.x | :white_check_mark: | -| 1.x.x | :x: | - -## Reporting a Vulnerability - -Use this section to tell people how to report a vulnerability. - -Tell them where to go, how often they can expect to get an update on a -reported vulnerability, what to expect if the vulnerability is accepted or -declined, etc. diff --git a/manual/_coverpage.md b/manual/_coverpage.md index b483c479..53544d54 100644 --- a/manual/_coverpage.md +++ b/manual/_coverpage.md @@ -1,33 +1,33 @@ + - -# GpgFrontend - A Cross-Platform OpenPGP Crypto Tool +# GpgFrontend    - [](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saturneric/GpgFrontend&utm_campaign=Badge_Grade) -[](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend?ref=badge_shield) -GpgFrontend is a Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and -Installation-Free [OpenPGP](https://www.openpgp.org/) Crypto Tool(using GnuPG). +**A Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free [OpenPGP(pgp)](https://www.openpgp.org/) +Crypto Tool.** -## Purpose +**Also, it's one of the excellent GUI Frontends for Modern GnuPG(gpg).** -Let more people all over the world can use GnuPG to safely send information to the destination in a safe way. +## Brief Introduction -## Features +You can quickly make encrypted documents or email. -- Can run on **Windows, Linux and macOS**. -- Open source and free. -- Even if you don't understand gpg, you can use it with this software. -- Just download, double-click, and then you can use it freely. -- Supports multiple languages. Languages spoken by most people in the world. +You can digitally sign your text or documents. +You can easily and intuitively manage all your keys on your computer. +## Features + +- Cross-Platform, can run on **Windows, Linux and macOS**. +- Open source, installation-free and free forever. +- Supports multiple languages. Languages spoken by most people in the world. -[Download Here](https://github.com/saturneric/GpgFrontend/releases/latest) -[Quick Start](quick-start.md) +[Download](https://github.com/saturneric/GpgFrontend/releases/latest) +[Manual](overview.md) <!-- 背景色 -->  diff --git a/manual/_media/_coverpage/gpgfrontend-logo.png b/manual/_media/_coverpage/gpgfrontend-logo.png Binary files differnew file mode 100644 index 00000000..7e9841be --- /dev/null +++ b/manual/_media/_coverpage/gpgfrontend-logo.png diff --git a/manual/_navbar.md b/manual/_navbar.md index 4044c3de..6c0b410e 100644 --- a/manual/_navbar.md +++ b/manual/_navbar.md @@ -1,9 +1,9 @@ <!-- _navbar.md --> -* [OpenPGP](https://www.openpgp.org/) -* [GnuPG](https://www.gnupg.org/) -* [Repository](https://gpgfrontend.bktus.com/?p=GPGFrontend.git;a=summary) -* [Github](https://github.com/saturneric/GpgFrontend) -* [Document](overview.md) +* [Source Code(Global CDN)](https://global.git.codesdream.com/GpgFrontend.git) +* [源代码(国内服务器)](https://git.codesdream.com/GpgFrontend.git) +* [GitHub Repository](https://github.com/saturneric/GpgFrontend) +* [Manual](overview.md) +* [Download](https://github.com/saturneric/GpgFrontend/releases/latest) * [Contract](contract.md) diff --git a/manual/_sidebar.md b/manual/_sidebar.md index d4b2854b..399909b7 100644 --- a/manual/_sidebar.md +++ b/manual/_sidebar.md @@ -1,25 +1,28 @@ - Getting Start - [Overview](overview.md) - [Quick Start](quick-start.md) - - Basic concepts + - [Basic concepts](basic-concepts.md) - Manual - [Understand Interface](manual/understand-interface.md) - [Encrypt & Decrypt Text](manual/encrypt-decrypt-text.md) + - Symmetric Encrypt & Decrypt Text - [Sign & Verify Text](manual/sign-verify-text.md) - [Encrypt & Decrypt File](manual/encrypt-decrypt-file.md) - [Sign & Verify File](manual/sign-verify-file.md) - [Generate Key Pair & Subkey](manual/generate-key.md) - [View Key Pair Details](manual/view-keypair-info.md) - [Import & Export Key Pair](manual/import-export-key-pair.md) - - Key Server Operations - - Email Operations - - Sync + - [Key Server Operations](manual/key-server-operations.md) + - [Email Operations](manual/email-operations.md) + - [Advanced Key Operation](manual/advance-key-opera.md) - Features Guides - [Introduce](features/introduce.md) - [Short Cipher-text](features/short-ciphertext.md) - - [Public Key Sync](features/automatic-pubkey-exchange.md) + - [Sync ALL Public Key](features/sync-all-public-keys.md) + - Export As Key Package - Contribute - [Translate Interface](translate-interface.md) + - Contribute Code - About - [FAQ](faq.md) - [Code & Binary Verify](about/code-binary-verify.md) diff --git a/manual/basic-concepts.md b/manual/basic-concepts.md index e69de29b..638c19e3 100644 --- a/manual/basic-concepts.md +++ b/manual/basic-concepts.md @@ -0,0 +1,58 @@ +# Basic Concepts + +If you don't know GPG, or PGP, you may need to learn some basic concepts here before using Gpg Frontend. This reduces +the chance of you making mistakes, such as distributing your private key to the world. + +## The most basic concepts you must know + +First, you need to generate a key pair, which you can imagine as a key ring. Each key pair has at least two keys, a +public key and a corresponding private key. These two keys form a key pair. There can also be multiple public keys and +their (one-to-one correspondence) private keys in a key pair, which will be described later. The public key can be +released to the outside world. Others can use your public key to encrypt the information they want to give you. The +private key is kept by yourself. If it is leaked, your encryption will no longer be meaningful. + +What you need to know is that the public key is used to encrypt information, and the ciphertext encrypted by others +using the public key you released is guaranteed to be decrypted only by the corresponding private key of your key pair. +This process involves some The principle of cryptography, you can trust this process unless no one knows your private +key except you. The reverse of this process is also valid, you can encrypt a message with your private key, and someone +else decrypts the message with your public key. The significance of this inverse process is that if the person using the +public key cannot normally decrypt a message encrypted with the private key, then it is certain that the message does +not come from the person who owns the private key corresponding to the public key. . This process can also be trusted. +It can be seen that this reverse process establishes a process of signing and then verifying. Information encrypted with +the private key can be seen as a signature. Others can use the public key to verify that the signature is valid. + +If you just want to use the tool, you don't need to understand the cryptography behind it, you just need to remember the +above. + +If you want to know more, you can read on. + +## Multiple pairs of public and private keys in a key pair + +In a key pair, there is at least one pair of public key and private key, but there is no limit to the maximum number of +pairs. You can generate another pair of public and private keys (we call them subkeys), and then add them to the key +pair, but it is worth noting that the newly added public and private key pairs are the same as the first pair. Pairs +have a public key and private key (which we call the primary key) pair associated. + +You can specify which process a subkey pair is used for. For example, the first key pair is used for encryption and +decryption, the second key pair is used for signing and verification, or the third key pair can be used for encryption +and decryption. Used to do the above two key pairs at the same time. Please specify these things when generating the +subkey. + +The master key is automatically generated when the key pair is generated, and the subkey can be added by the user at +will. + +When generating the master key or subkey, you can choose some algorithms such as RSA, DSA, etc. You do not need to +understand the specific principles of these. You just need to know that subkeys generated by certain algorithms cannot +perform certain processes (such as encryption and decryption), but can only perform certain processes (such as signing +and verification). It is worth mentioning that for RSA, you can choose the key length when using the algorithm, you can +think that the key + +## The first pair of public and private keys in a key pair (primary key) + +The first pair of public and private keys (master key) in a key pair is very critical, because subsequent public and +private keys (sub-keys) are linked to them, you can think that if someone else gets yours Master key (including public +and private key information), he can generate sub-keys based on the information of the master key, and then he can use +the sub-keys he generated to impersonate you and communicate with others. + +Therefore, the private key of the master key (the public key can be released to others) must not be leaked. The +disclosure of its private key means that the entire key pair is no longer safe and must be stopped immediately. diff --git a/manual/contract.md b/manual/contract.md index 47dfe5e4..bb9de59b 100644 --- a/manual/contract.md +++ b/manual/contract.md @@ -1,6 +1,9 @@ # Contract -Contents related to business and politics are rejected. This tool belongs to all mankind. If you have any questions about technology and improving this software, please feel free to contact me. +Contents related to business and politics are rejected. This tool belongs to all mankind. If you have any questions +about technology and improving this software, please feel free to contact me. + +It is recommended to use plain text to contact me by email, but HTML is not recommended. ## About ME @@ -12,7 +15,7 @@ Tips: BKTUS(Bakantu Union) is not a company, it is my personal domain name. ## Languages -You can write to me in the following language. +You can write to me in the following language. 1. English 2. Chinese @@ -20,6 +23,9 @@ You can write to me in the following language. ## GPG Public Key Info +This is the PGP public key that I support for a long time. You can use this public key to establish encrypted +communication with me. Please use plain text for encrypted communication, do not use rich text formats such as HTML. + ``` -----BEGIN PGP PUBLIC KEY BLOCK----- diff --git a/manual/faq.md b/manual/faq.md index 0823d4ff..b53c149a 100644 --- a/manual/faq.md +++ b/manual/faq.md @@ -1,36 +1,46 @@ # FAQ -## What is GpgFrontend +## What is GpgFrontend？ -GpgFrontend is a cross-platform encryption tool that conforms to the OpenPGP standard. -It is committed to making OpenPGP easier to use, so that more people can use the tool to protect their privacy. +GpgFrontend is a cross-platform encryption tool that conforms to the OpenPGP standard. It is committed to making OpenPGP +easier to use, so that more people can use the tool to protect their privacy. -## Relationship with OpenPGP(pgp) and Gnupg(gpg) +## Relationship with OpenPGP(pgp) and Gnupg(gpg)？ -OpenPGP is a data encryption and decryption standard, and GpgFrontend supports it. -GnuPG is a cryptographic software used to encrypt, sign communication content and manage keys for asymmetric cryptography. It follows the OpenPGP standard. -GpgFrontend drives gnupg at runtime to implement operations such as encryption and decryption. +OpenPGP is a data encryption and decryption standard, and GpgFrontend supports it. GnuPG is a cryptographic software +used to encrypt, sign communication content and manage keys for asymmetric cryptography. It follows the OpenPGP +standard. GpgFrontend drives gnupg at runtime to implement operations such as encryption and decryption. -## How to obtain and use GpgFrontend +## How to obtain and use GpgFrontend？ -The various versions of GpgFrontend will be released in the GitHub repository, and you can find and download the latest version in Releases. -After downloading, you can refer to the instructions in ReadME and you can start using it in just a few steps. +The various versions of GpgFrontend will be released in the GitHub repository, and you can find and download the latest +version in Releases. After downloading, you can refer to the instructions in ReadME and you can start using it in just a +few steps. ## I found some flaws in GpgFrontend, what should I do? -If you find a defect in GpgFrontend, you are welcome to create an issue in the Github repository to describe the problem. When I see your issue, I will respond as soon as possible. -If you do not have a GitHub account, please send an email to my personal mailbox. For contact information, please see Contract. +If you find a defect in GpgFrontend, you are welcome to create an issue in the GitHub repository to describe the +problem. When I see your issue, I will respond as soon as possible. If you do not have a GitHub account, please email my +personal mailbox. For contact information, please see [Contract](contract.md). ## Can I modify the code of GpgFrontend? -If you have any good ideas, you are free to modify the code of GpgFrontend. You are welcome to submit a Pull Request to add your good ideas to the next version. +If you have any good ideas, you are free to modify the code of GpgFrontend. You are welcome to submit a Pull Request to +add your good ideas to the next version. -## Why should I install GnuPG additionally +You can contribute completely anonymously, and you can email me patches. -The source code of GpgFrontend does not contain operations such as encryption and decryption, which requires Gnupg to provide support. In addition, for users with higher security requirements, they can let GpgFrontend drive their trusted copy of Gnupg. -This design improves the security of GpgFrontend. +## Why should I install GnuPG additionally? -## What is the release version with BETA +The source code of GpgFrontend does not contain operations such as encryption and decryption, which requires Gnupg to +provide support. In addition, for users with higher security requirements, they can let GpgFrontend drive their trusted +copy of Gnupg. This design improves the security of GpgFrontend. -The release version with the word "beta" means that some modules of this version have not yet been thoroughly tested. In addition, some of the support for the beta version may not be complete. But rest assured, I will test after the beta version is released, and release a stable version at an appropriate time. +## What is the release version with BETA? + +The release version with the word "beta" means that some modules of this version have not yet been thoroughly tested. In +addition, some support for the beta version may not be complete. But rest assured, I will test after the beta version is +released, and release a stable version at an appropriate time. + +But starting from 2.0.0, BETA versions will not be released unless there are special circumstances. diff --git a/manual/features/automatic-pubkey-exchange.md b/manual/features/automatic-pubkey-exchange.md deleted file mode 100644 index 94ae12de..00000000 --- a/manual/features/automatic-pubkey-exchange.md +++ /dev/null @@ -1,17 +0,0 @@ -# Public Key Sync - -Sometimes, you need to keep your local key consistent with the one on the key server. This is critical in cases where a key owner revokes its key, at which point you need to stop using the key immediately. This avoids potential man-in-the-middle attacks. Or, if the key owner creates a new subkey for signing, gpg will not be able to verify the validity of the ciphertext if the ciphertext he sends to you signs with the subkey and you do not have local information about the subkey. - -## How to use - -It's very simple, after clicking the Sync Public Key button in the Key ToolBox or the Key Management interface on the homepage, things will be done automatically. - - - -This feature will check all the public keys you now have (only the public key, not any private keys) and then search for it in the key server. If the corresponding public key is found in the key server, GpgFrontend will import the latest public key from the key server to the local. - -### Key server - -How do I know which key server GpgFrontend accessed? It's simple, GpgFrontned will exchange keys using the default key server you set up. If you need to change the key server you need to access, you just need to add your key server in the settings and set it as the default. - - diff --git a/manual/features/sync-all-public-keys.md b/manual/features/sync-all-public-keys.md new file mode 100644 index 00000000..cfc87d60 --- /dev/null +++ b/manual/features/sync-all-public-keys.md @@ -0,0 +1,26 @@ +# Public Key Sync + +Sometimes, you need to keep your local key consistent with the one on the key server. This is critical in cases where a +key owner revokes its key, at which point you need to stop using the key immediately. This avoids potential +man-in-the-middle attacks. Or, if the key owner creates a new subkey for signing, gpg will not be able to verify the +validity of the ciphertext if the ciphertext he sends to you signs with the subkey and you do not have local information +about the subkey. + +## How to use + +It's very simple, after clicking the Sync Public Key button in the the Key Management interface, things will be done +automatically. + + + +This feature will check all the public keys you now have (only the public key, not any private keys) and then search for +it in the key server. If the corresponding public key is found in the key server, GpgFrontend will import the latest +public key from the key server to the local. + +### Which Key Server Was Used + +How do I know which key server GpgFrontend accessed? It's simple, GpgFrontend will exchange keys using the default key +server you set up. If you need to change the key server you need to access, you just need to add your key server in the +settings and set it as the default. + + diff --git a/manual/index.html.bak b/manual/index.html.bak deleted file mode 100644 index 671a6e38..00000000 --- a/manual/index.html.bak +++ /dev/null @@ -1,33 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<head> - <meta charset="UTF-8"> - <title>GpgFrontend - An OpenPGP Frontend Tool</title> - <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> - <meta name="description" content="Description"> - <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"> - <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"> - <link rel="shortcut icon" href="/_media/icon.png" type="image/x-icon"> -</head> -<body> - <div id="app"></div> - <script> - window.$docsify = { - logo: '/_media/trademark.png', - name: 'GpgFrontend', - loadNavbar: true, - loadSidebar: true, - coverpage: true, - onlyCover: true, - subMaxLevel: 3, - alias: { - '/.*/_sidebar.md': '/_sidebar.md' - } - } - </script> - <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script> - <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script> - <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script> - <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script> -</body> -</html> diff --git a/manual/manual/advance-key-opera.md b/manual/manual/advance-key-opera.md index 4e086f71..c8b646a4 100644 --- a/manual/manual/advance-key-opera.md +++ b/manual/manual/advance-key-opera.md @@ -1,4 +1,3 @@ # Advance Key Operation -Some advanced key operations will be introduced in this module. -There are some operations that you may not use most of the time. +Some advanced key operations will be introduced in this module.
\ No newline at end of file diff --git a/manual/manual/email-operations.md b/manual/manual/email-operations.md new file mode 100644 index 00000000..6d460e60 --- /dev/null +++ b/manual/manual/email-operations.md @@ -0,0 +1 @@ +# Email Operations
\ No newline at end of file diff --git a/manual/manual/encrypt-decrypt-file.md b/manual/manual/encrypt-decrypt-file.md index 752c341f..230480b1 100644 --- a/manual/manual/encrypt-decrypt-file.md +++ b/manual/manual/encrypt-decrypt-file.md @@ -1,23 +1,34 @@ # Encrypt & Sign File -GpgFrontend provides two ways to perform file operations, a quick way and a custom way. The fast way is to use the -right-click menu of the file browser. It provides the recommended method for encryption and decryption operations ( -encrypt & sign OR decrypt & verify). The custom way provides two outdated but general and old functions: only encryption -and only decryption. +Gpg Frontend provides a convenient and fast way to operate on files. The concept of encryption and decryption files is +almost the same as text, except that the input and output of file operations can be binary. -The following is divided into two parts to introduce the above two ways respectively. +## File Extension Introduction -## Fast Way +For ciphertext in ASCII format, its filename suffix is usually asc, and you can directly open such files with a text +editor. However, if the ciphertext is binary, its file extension will be gpg. Usually, binary ciphertext files are +smaller than ASCII format. + +Before v2.0.4, the ciphertext files generated by GpgFrontend are all in ASCII format. But starting from v2.0.4, +GpgFrontend will generate ciphertext files in binary format by default. you can change this setting in settings. + + + +## File Browser In the top menu file option, you can open the file browser(Ctrl/Command + B). Then by using the file browser, first enter your working directory. Then right-click the file you need to operate, and then select the operation you want in the pop-up menu. - + There are two control buttons at the top of the file tab. The one on the left is the up level, and the one on the right is to enter or refresh the corresponding path in the input box on the left. +On the far right is a button with useful options that you can tick to show system files or hidden files. + + + ### Encrypt & Sign This method provides encryption and signature functions, which GpgFrontend recommend, so that the receiver can know that @@ -27,40 +38,15 @@ this operation. This operation generates a file with the gpg extension. The file with this suffix contains both encrypted content and signed content. - + ### Decrypt & Verify This ciphertext is verified while decrypting, which can improve security. In addition, you can also perform Only Verify operations and this operation will verify without decryption. To use this operation, you need to select a file with a -gpg extension, which contains the ciphertext and signature content. - - - -## Custom Way - -The custom mode provides a more flexible operation scheme for files. You can specify the directory, file name and suffix -of the output file. - - - - - -### Encrypt - -This operation will only encrypt the file which means the receiver won't know who this ciphertext is created by. This -operation will generate a file with the suffix asc, which contains ciphertext. - - - -### Decrypt - -For decryption, you do not need to check the corresponding key from the table. GpgFrontend will make the selection -automatically. To use this operation, you need to select a file with an extension of gpg or asc, which contains -ciphertext. - - - - +gpg or asc extension, which contains the ciphertext and signature content. +In order to encourage users to check whether the ciphertext is signed or not when decrypting, Gpg Frontend does not +provide a separate decryption operation here. + diff --git a/manual/manual/encrypt-decrypt-text.md b/manual/manual/encrypt-decrypt-text.md index 130148b5..ad36880a 100644 --- a/manual/manual/encrypt-decrypt-text.md +++ b/manual/manual/encrypt-decrypt-text.md @@ -1,51 +1,83 @@ # Encrypt & Decrypt Text -To start encryption and decryption operations, you need to prepare your plain text. In addition, you also need a public key that can perform encryption operations. How to generate such a key can be found in the chapter on generating a key pair. +To start encryption and decryption operations, you need to prepare your plain text. In addition, you also need a public +key that can perform encryption operations. How to generate such a key can be found in the chapter on generating a key +pair. ## Encrypt -The Encrypt operation itself uses a public key and does not require a private key. Remember that whoever you want to send it to encrypts it with whose public key. For people who don't use gpg very often, they often get confused and use their own keys to encrypt ciphertext. +The Encrypt operation itself uses a public key and does not require a private key. Remember that whoever you want to +send it to encrypts it with whose public key. For people who don't use gpg very often, they often get confused and use +their own keys to encrypt ciphertext. -Note that if you want to encrypt your text and send it to "foo", you need to know foo's public key first. Then you need to encrypt your text with foo's public key instead of using your public key. Before encrypting, check to see if the public key has cryptographic capabilities. This can be viewed in the usage column of the key toolbox (the letter E stands for encryption). +Note that if you want to encrypt your text and send it to "foo", you need to know foo's public key first. Then you need +to encrypt your text with foo's public key instead of using your public key. Before encrypting, check to see if the +public key has cryptographic capabilities. This can be viewed in the usage column of the key toolbox (the letter E +stands for encryption). -It is worth mentioning that if you only use foo's public key to encrypt the ciphertext, no one but foo's own private key can decrypt the ciphertext. There is a situation where you want ciphertexts to be decrypted by multiple people (including yourself), please check their corresponding public keys before doing so. After an encryption operation, if you misuse (some people's public keys are found to be missing), you can use the undo operation to restore your original ciphertext before closing GpgFrontend. +It is worth mentioning that if you only use foo's public key to encrypt the ciphertext, no one but foo's own private key +can decrypt the ciphertext. There is a situation where you want ciphertexts to be decrypted by multiple people ( +including yourself), please check their corresponding public keys before doing so. After an encryption operation, if you +misuse (some people's public keys are found to be missing), you can use the undo operation to restore your original +ciphertext before closing GpgFrontend. ### Only Encrypt -In this case, you only encrypt the ciphertext, and the ciphertext will be shorter. Because in operation, the ciphertext does not contain additional signature information to determine the identity of the encryptor. If you don't want to receive your mestigraphs knowing your identity, use this method to generate your ciphertexts. +In this case, you only encrypt the ciphertext, and the ciphertext will be shorter. Because in operation, the ciphertext +does not contain additional signature information to determine the identity of the encryptor. If you don't want to +receive your graphemes knowing your identity, use this method to generate your ciphertexts. -After the encrypted operation, there is no additional information display in the information board except for the prompt of whether the operation is successful. +After the encrypted operation, there is no additional information display in the information board except for the prompt +of whether the operation is successful. - - + ### Encrypt Sign -By encrypting and signing at the same time, not only can the text be protected, but the recipient can also know that thecipher text is from your hand. This encryption is often used in scenarios where both parties need to ensure that the decrypted text is credible, and in general, in that scenario, the upper reaches know each other. The ciphertext generated by this operation is longer because of the additional signature information attached to it. +By encrypting and signing at the same time, not only can the text be protected, but the recipient can also know that +thecipher text is from your hand. This encryption is often used in scenarios where both parties need to ensure that the +decrypted text is credible, and in general, in that scenario, the upper reaches know each other. The ciphertext +generated by this operation is longer because of the additional signature information attached to it. -Before doing so, you only need to select the public key(s) you need to use for encryption. Halfway through the encryption operation, you'll be asked to choose the private key you need to use for signing. That is, the signer. If you don't find the key you want in the Signaler list, confirm that your private key can be used for encryption and is valid. To check whether the key can be used for signing, please check the usage column in the key toolbox on the right (letter S stands for signature). You can select the public key to use for encryption, or you can select the public key to use for signing. +Before doing so, you only need to select the public key(s) you need to use for encryption. Halfway through the +encryption operation, you'll be asked to choose the private key you need to use for signing. That is, the signer. If you +don't find the key you want in the Signaler list, confirm that your private key can be used for encryption and is valid. +To check whether the key can be used for signing, please check the usage column in the key toolbox on the right (letter +S stands for signature). You can select the public key to use for encryption, or you can select the public key to use +for signing. -For this type of ciphertext, you can use the validate operation to see if the ciphertext is trustworthy before decryption. +For this type of ciphertext, you can use the validate operation to see if the ciphertext is trustworthy before +decryption. -When the operation is complete, information about the cryptographic operation and the signature operation is displayed in the Infomation Board. You can view information about the signature, such as the pattern of your signature and the algorithm used (you can indirectly see which subkey you used to sign). Please note the distinction between the dates used in your signature messages in UTC and not your local time. +When the operation is complete, information about the cryptographic operation and the signature operation is displayed +in the Infomation Board. You can view information about the signature, such as the pattern of your signature and the +algorithm used (you can indirectly see which subkey you used to sign). Please note the distinction between the dates +used in your signature messages in UTC and not your local time.  ## Decrypt -Paste the ciphertext you obtained directly, gpg will automatically select the appropriate key in the list for decryption. Always remember to decrypt with the private key. +Paste the ciphertext you obtained directly, gpg will automatically select the appropriate key in the list for +decryption. Always remember to decrypt with the private key. -Whether a key pair can be used for decryption will not be displayed in the usage column. You only need to remember that a valid private key can be used to decrypt the ciphertext encrypted with the related public key. + -Regarding whether this key is a public key or a private key, you can check the type column in the key toolbox. +Whether a key pair can be used for decryption will not be displayed in the usage column. You only need to remember that +a valid private key can be used to decrypt the ciphertext encrypted with the related public key. - +Regarding whether this key is a public key or a private key, you can check the type column in the key toolbox. However, +you do not need to check the corresponding key before decryption. And when all your local keys cannot be used for +decryption, the program will prompt decryption failure. ## Decrypt Verify While decrypting, you can learn some information about the encryptor of the key (if you signed it during encryption). -Whether a key pair can be used for verification will not be displayed in the usage column, you only need to remember a valid public key can be used for verificationWhether a key pair can be used for verification will not be displayed in the usage column, you only need to remember a valid public key can be used for verification. -Regarding whether this key is a public key or a private key, you can check the type column in the key toolbox. +Whether a key pair can be used for verification will not be displayed in the usage column, you only need to remember a +valid public key can be used for verification. + +This is a good habit regardless of whether the encryptor has signed in advance. Because you cannot infer from the format +of the ciphertext whether it has been signed or not. So, use decryption operations with verification whenever possible. - + diff --git a/manual/manual/generate-key.md b/manual/manual/generate-key.md index ba663242..848e6a8c 100644 --- a/manual/manual/generate-key.md +++ b/manual/manual/generate-key.md @@ -2,17 +2,17 @@ For GpgFrontend, to understand the key, you must first understand two concepts: key pair and subkey. -A key pair can be compared to a key ring. When it is generated, there is a key in the ring called the master key. This -master key can do the intended operation (encryption, decryption, etc.). At the same time, keep this in mind, only -through the master key can you open the keychain to add new keys to it. +A key pair can be compared to a key ring. When it is generated, there is a key in the ring called the primary key. This +primary key can do the intended operation (encryption, decryption, etc.). At the same time, keep this in mind, only +through the primary key can you open the keychain to add new keys to it. The sub-keys can be analogous to the keys you add to the key pair later, and each of them can independently perform -operations such as encryption and decryption. It can be considered that the master key mentioned above is a special +operations such as encryption and decryption. It can be considered that the primary key mentioned above is a special subkey. -When there is no master key in the key pair, you will not be able to open the key ring to add a new sub key, but you can -still use this sub key if it is changed to exist for your operations. This mechanism is very helpful to the security of -the key. +When there is no primary key in the key pair, you will not be able to open the key ring to add a new sub key, but you +can still use this sub key if it is changed to exist for your operations. This mechanism is very helpful to the security +of the key. Let's see how to generate them next. @@ -39,7 +39,7 @@ it does will be logically invalid (especially for signature operations). GpgFron to two years later. If you wish, check the Never expire checkbox to make this key pair never expire. But don't worry, you can change this option at any time after generation, even long after the expiration date (as long -as the master key exists). +as the primary key exists).  @@ -50,22 +50,23 @@ will give you sufficient hints on the UI so that you will not go wrong. Just remember that the larger the key length, the more secure, but it will be slower when performing operations. -!treeModuleSelected[keysize-algo](https://github.com/saturneric/Blob/blob/master/screenshots/keysize-algo.png?raw=true) + ### Passphrase -You can set a key to protect the master key, which is very important when the master key is leaked. -When the Do not set password check box is not checked, an interface for you to enter the password will pop up during the process of generating the password. -Just follow the prompts. -After setting the password, when you need to use the master key for operation, you may enter the password to unlock it +You can set a key to protect the primary key, which is very important when the primary key is leaked. When the Do not +set password check box is not checked, an interface for you to enter the password will pop up during the process of +generating the password. Just follow the prompts. After setting the password, when you need to use the primary key for +operation, you may enter the password to unlock it (some systems have a password networkAccessManager to take over this process). -You can also check the checkbox to not set a protection password for the master key, but due to security considerations, this is not recommended. +You can also check the checkbox to not set a protection password for the primary key, but due to security +considerations, this is not recommended. ### Usage In the option of generating a key pair, you can specify the usage for the first subkey of the key pair, which is the -master key. There are four options: +primary key. There are four options:  @@ -73,13 +74,13 @@ master key. There are four options: - Signing: After generation, it can be used for signature operations. -- Certification: Popular understanding can be used to unlock this key ring (key pair). Only the master key can check +- Certification: Popular understanding can be used to unlock this key ring (key pair). Only the primary key can check this function. - Authentication: It can perform authentication operations like SSH keys. -The third of these four uses (authentication purposes) can only be owned by the master key. In addition, some usages are -not available when using certain algorithms for encryption. For example, when the DSA algorithm is selected, the +The third of these four uses (authentication purposes) can only be owned by the primary key. In addition, some usages +are not available when using certain algorithms for encryption. For example, when the DSA algorithm is selected, the encryption uses are disabled. ## Generate Subkey @@ -89,25 +90,27 @@ The rest is basically the same as generating the key pair.  - ### Extra note -#### Master Key & Subkey +Here are some tips you might want to know. These tips will help you better understand the above concepts and use this +tool correctly. + +#### primary key & Subkey -A key pair can have multiple subkeys and one master key. Using this design reduces the risk of key leakage. For subkey, -After the subkey is leaked, you can revoke it at any time to reduce the loss. However, when the master key is leaked, +A key pair can have multiple subkeys and one primary key. Using this design reduces the risk of key leakage. For subkey, +After the subkey is leaked, you can revoke it at any time to reduce the loss. However, when the primary key is leaked, the entire key pair will be insecure (the popular reason is that the main force can be used to manage this key pair). Therefore, the recommended approach is to generate multiple subkeys after creating the key pair, and export the master key separately and store it in a safe place. This operation is not yet supported by GpgFrontend, you need to use the gpg -command to perform it. But gpgfrontend can identify and prompt the user whether the master key exists or not. This is +command to perform it. But gpgfrontend can identify and prompt the user whether the primary key exists or not. This is very important, because some special operations (adding subkeys, signing other keys, etc.) cannot be performed without -the master key. +the primary key. #### Some practical tips -The purpose of the master key cannot be changed after it is generated. If the master key of this key pair -does not have a certain purpose, but a certain sub-key has this purpose, this key pair can still be used for operations +The purpose of the primary key cannot be changed after it is generated. If the primary key of this key pair does not +have a certain purpose, but a certain sub-key has this purpose, this key pair can still be used for operations corresponding to this purpose. For example, when you generated the key pair, you didn't check the encryption usage. Don't worry, you can generate a diff --git a/manual/manual/import-export-key-pair.md b/manual/manual/import-export-key-pair.md index 0c9f85ba..96e5ee35 100644 --- a/manual/manual/import-export-key-pair.md +++ b/manual/manual/import-export-key-pair.md @@ -1,50 +1,100 @@ # Import & Export Key Pair -GpgFrontend provides multiple ways for users to import or export key paris. Read the guide. +GpgFrontend provides multiple ways for users to import or export key paris. Here we will introduce some classic +operations. Read the guide. -# Import Key Pair +## Import Key Pair -You can find the import options in the toolbar. You can choose several import methods according to your actual situation. -Let’s introduce these methods. +You can find the import options in the toolbar. You can choose several import methods according to your actual +situation. Let’s introduce these methods. -## File + -When you select this option, you need to select a public key or private key file that meets the standard. -The file you choose should be in text format, with any extension. +In fact, you can find this action menu in key management, and here you can do more actions. -## Editor + -You can paste the contents of the key file on a blank text label page. Then click this option, GpgFrontend will automatically recognize and import the corresponding key. +### File -## Clipboard +When you select this option, you need to select a public key or private key file that meets the standard. The file you +choose should be in text format, with any extension. -You can copy the contents of the key to your system clipboard somewhere else. Then, after selecting this option, the corresponding key will be imported. +### Editor -## Keyserver +You can paste the contents of the key file on a blank text label page. Then click this option, GpgFrontend will +automatically recognize and import the corresponding key. -After selecting this option, you can enter the email or ID corresponding to the key in the pop-up selection, and then select the appropriate key server. -Then after clicking the search button, GpgFrontend will list the public keys that can be imported in the key server. -You can import them together, or you can choose to double-click the table row to import the corresponding public key. -Note: The keys imported in this way are all public keys. +### Clipboard -## Dropdown on Key Toolbox +You can copy the contents of the key to your system clipboard somewhere else. Then, after selecting this option, the +corresponding key will be imported. + +### Keyserver + +After selecting this option, you can enter the email or ID corresponding to the key in the pop-up selection, and then +select the appropriate key server. Then after clicking the search button, GpgFrontend will list the public keys that can +be imported in the key server. You can import them together, or you can choose to double-click the table row to import +the corresponding public key. Note: The keys imported in this way are all public keys. + +A detailed description of this part can be found [Here](./key-server-operations.md). + +### Dropdown on Key Toolbox You can drag the key file directly to the key toolbox, and then follow the prompts of GpgFrontend to import the key. -# Export Key Pair +## Export Key Pair + +Deriving the public key of a key pair with the private key means deriving either the public key or the private key or +both of all the keys present in the key pair. If there are very many keys in the key pair, the exported data will be +very long. Similar to import, there are multiple export methods. + +For Gpg Frontend, the exported data is encoded in ASCII, which ensures data compatibility between computers. + +### Export Public Key + +you can find this operation in many places.The following will introduce them one by one. + +#### Append Public Key to Editor + +Right-click a row in the key toolbox, and click Append Select Key(s) to Editor in the pop-up menu item. You will find +that the public key that the key is right appears at the end of your text label page. You can freely copy the content to +any place. + +#### Export on the Key Pair at Operations Tab + +You can do this as shown in the screenshot below, which will store the data to a file. Please select a suitable +directory to store this file containing the public key data before going anywhere. + + + +### Export multiple public keys at once + +You can export all public key data in multiple key pairs at one time, and you can select the key pairs you want to +export on the key management interface. Then, you can click Export to Clipboard. + + + +### Export Private Key + +You can find private key options everywhere in the detail's page that contains the private key (primary key or subkey). +Then you can select a location, and GpgFrontend will export the corresponding private key content to that location +later. + + -Similar to import, there are multiple export methods. +Exporting the private key also exports the public key and private key data, because the private key data without the +public key is meaningless by itself, you cannot deduce the public key from the private key. -## Append Pubkey to Editor +Generally speaking, the private key content will be bundled with the public key content to export and export. Please +note: the private key file can never be disclosed to others. If it is leaked, it means that all ciphertexts encrypted by +the key are no longer safe. -Right-click a row in the key toolbox, and click Append Select Key(s) to Editor in the pop-up menu item. -You will find that the public key that the key is right appears at the end of your text label page. -You can freely copy the content to any place. +You can export the private key data in your key pair in two ways. -## Export Private Key +1. Full export: Include all key data and UID and UID signature in the key pair. +2. Minimal export: Only all key data in the key pair is included. -You can find private key options everywhere in the details page that contains the private key (master key or subkey). -Then you can select a location, and GpgFrontend will export the corresponding private key content to that location later. -Generally speaking, the private key content will be bundled with the public key content to export and export. -Please note: the private key file can never be disclosed to others. If it is leaked, it means that all ciphertexts encrypted by the key are no longer safe. +### Securely export and transfer as a Key Package +You can package the private key data or public key data of multiple key pairs into a Key Package to allow them to be +securely transferred between your PC devices. This part of the function will be introduced in the feature.
\ No newline at end of file diff --git a/manual/manual/key-server-operations.md b/manual/manual/key-server-operations.md new file mode 100644 index 00000000..856b01e6 --- /dev/null +++ b/manual/manual/key-server-operations.md @@ -0,0 +1,113 @@ +# Key Server Operations + +You want to use encrypted communication, but in some cases, you only know the email address to which your message is +sent, but you don't know what the public key of the owner of the email address is. + +This is one situation, and another situation is that your key is accidentally leaked. How do you notify the person who +holds your public key to stop using your public key to continue sending you encrypted information? For these people, you +may not even know their names or contact information. In the above cases, you may be able to use the key server to +complete the sharing of key information. You can upload your public key information to the key server, or search or pull +the public key you need from the key server by email address and key ID. + +Once the public key information is uploaded to the key server, it will be transmitted between the key servers until +finally all the key servers store your public key for access by people all over the world. + +GpgFrontend provides the ability to interact with the key server. Through mouse operation, you can quickly use the key +server to share your public key, or search and import the public key you want. It should be noted that once the public +key information is uploaded to the key server, it means that the public key information cannot be deleted from the key +server and will always be retained. but when you add a subkey to your key pair, the public key of the old key pair can +be overwritten by updating. + +## Import Public Key From Key Server + +In the main page or in the key manager's Import key operation mode, there is a key server option. After selecting this +option you can see such an interface. + + + +You can get a list of public keys associated with a key server by searching for Key ID, fingerprint or email address via +the search box. If there is a suitable public key in the list, you can import it by double-clicking it. + + + +When the import is complete, you can check whether the public key is actually imported through the pop-up window (no +need to import when the local public key is newer), and you can also check some brief information about the public key. + + + +It is worth noting that the public key you imported may be expired or revoked. You can view the status of the key +through the category tab in the key management interface. In addition to the search box, you also noticed that you can +choose which key server to grab the public key information from by clicking on the drop-down box. How to set or add this +candidate list, please refer to the last section of this document: Key server related settings. + +## Export My Public Key To The Keyserver + +When the current key pair has a master key, you can publish the public key information to the key server. Note that in +order to be able to let users know what they are actually doing, GpgFrontend specifies that this can only be done if a +master key exists for the local key pair. This avoids confusion about the function. + +### How To Use + +You can find the entry of this operation through the operation tab of the key pair detail interface, as shown in the +following figure. + + + +Perform the operation by clicking Upload key pair to key server. Note that the naming of operations here is a bit +confusing, but this is where your public key information (not your private key) will be uploaded. + +### Synchronize public key information from a key server + +Sometimes, before you perform an encryption operation, you want to know if the public key you are using is still valid. +At this point, you can get the latest information about the key from the key server (if the public key server has one). + +As above, you can find this action in the Actions tab of the key pair details screen, as shown in the image below. + +### Extra Information + +Gpg Frontend will upload the public key information to the default key server you set. The private key information is +not uploaded and should not be manually uploaded anywhere by the user. + +Refer to the last section of this document on how to set the default key server. + + + +By clicking Synchronize key pair with key server, the public key information can be automatically pulled from the key +server and compared with the local key information. After the operation is complete, you can check in the pop-up window +whether the key has actually been updated. It is worth noting that you will not be able to perform this operation if the +private key exists locally, the reason is that you already have the key pair and you should publish the latest +information for the key pair instead of accepting outdated information from the key server . + +### Extra Information + +Gpg Frontend will automatically communicate with the default keyserver you set and get the information it wants. Refer +to the last section of this document on how to set the default key server. + +## Sync ALL Public Key + +This is an advanced function provided by Gpg Frontend, it can synchronize all your local public key information at one +time, if you want to know, please read [this document](../features/sync-all-public-keys.md). + +## Key Server Related Settings + +如何What about setting a list of keyservers? Or set a default keyserver? At this point, you need to open the Settings +interface and find the Key Servers tab. Here you can see operations related to the key server candidate list, and see +which key server is the default key server. + + + +You can enter the http or https address of the key server you want to add in the input box, and then click Add to add a +candidate key server. In order to prevent man-in-the-middle attacks, users are strongly recommended to use the https +protocol. If you want to delete a candidate key server, you can right-click the row of the corresponding key server in +the table and click Delete in the pop-up menu. If you want to edit an existing candidate key server address, you can +double-click its address in the table and edit it. + +If you want to test the network connectivity of the servers in the key server candidate list, you can click the Test +button at the bottom. Note that the test here only tells you if the keyserver is reachable, not whether the address is a +valid keyserver. + +### Set Default Key Server + +If you want to set a candidate key server as your default key server, you can right-click the row of the corresponding +key server in the table, and click Set as Default in the pop-up menu. You can see if a candidate keyserver is the +default keyserver in the first column of the table.
\ No newline at end of file diff --git a/manual/manual/sign-verify-file.md b/manual/manual/sign-verify-file.md index 5a50bbd7..b62d62ae 100755 --- a/manual/manual/sign-verify-file.md +++ b/manual/manual/sign-verify-file.md @@ -1,47 +1,48 @@ # Sign & Verify File -GpgFrontend provides two ways to perform file operations, a quick way and a custom way. The fast way is to use the -right-click menu of the file browser. The custom way uses the file path designate interface. +Gpg Frontend provides a convenient and fast way to operate on files. The concept of signing and verifying files is +almost the same as text, except that the input and output of file operations can be binary. -The following is divided into two parts to introduce the above two ways respectively. +## File Extension Introduction -## Quick Way +For ciphertext in ASCII format, its filename suffix is usually asc, and you can directly open such files with a text +editor. However, if the ciphertext is binary, its file extension will be sig or gpg. Usually, binary ciphertext files +are smaller than ASCII format. + +Before v2.0.4, the ciphertext files generated by GpgFrontend are all in ASCII format. But starting from v2.0.4, +GpgFrontend will generate ciphertext files in binary format by default. you can change this setting in settings. + + + +## File Browser In the top menu file option, you can open the file browser(Ctrl/Command + B). Then by using the file browser, first enter your working directory. Then right-click the file you need to operate, and then select the operation you want in the pop-up menu. - + There are two control buttons at the top of the file tab. The one on the left is the up level, and the one on the right is to enter or refresh the corresponding path in the input box on the left. +On the far right is a button with useful options that you can tick to show system files or hidden files. + + + ### Sign -Through the right-click menu, you can quickly sign a file. This operation will generate a file with a sig suffix, which -contains the signature content. In this case, you need to pass this file along with the original file so that the other -party can verify it. +Through the right-click menu, you can quickly sign a file. This operation will generate a file with a sig or asc suffix, +which contains the signature content. In this case, you need to pass this file along with the original file so that the +other party can verify it. + + ### Verify -This operation needs to select a file with a gpg suffix (may be invalid for the ciphertext of a binary file) or a file +This operation needs to select a file with a gpg suffix (maybe invalid for the ciphertext of a binary file) or a file with a sig suffix for verification. When selecting a file with the sig suffix, make sure that the source file is also in this directory. This means that the name of the source file is just missing a sig suffix. -## Custom Way - -The custom mode provides a more flexible operation scheme for files. You can specify the directory, file name and suffix -of the output file. - -### Sign - -This operation will generate a file with a sig suffix(You can customize the name and path of the generated file), which -contains the signature content. In this case, you need to pass this file along with the original file so that the other -party can verify it. - -### Verify - -Consistent with fast operation. The difference is that you can specify the path of the source file and the signature -file, and their naming rules are basically unlimited.
\ No newline at end of file +
\ No newline at end of file diff --git a/manual/manual/sign-verify-text.md b/manual/manual/sign-verify-text.md index c8d35078..f3ed699f 100644 --- a/manual/manual/sign-verify-text.md +++ b/manual/manual/sign-verify-text.md @@ -1,33 +1,46 @@ # Sign & Verify Text +In general, the process of signing and verifying is the reverse process of encryption and decryption. When signing, the +private key is used, and when verifying, the public key is used. And just like signing one name after another on a +document, multiple private keys can be selected when signing. But there are some differences. Digital signatures can be +used to verify whether the content of the signature has changed, while handwritten signatures are difficult to do. + ## Only Sign By signing the text, you can show that you are the only and unchangeable certification with this text. You can just sign the text without encrypting the text like the following. -To check whether the key can be used for signing, please check the usage column in the key toolbox on the right (letter S stands for signature). + - +To check whether the key can be used for signing, please check the usage column in the key toolbox on the right (letter +S stands for signature). ## Sign With Encrypt -You can also encrypt this short text while signing, which is equivalent to signing while encrypting. -A typical usage method is to check two key pairs, one is someone else's public key, which is used for encryption; the other is your own private key, which is used for signing. -If you do not check any key that can be used for signing, this is possible (equivalent to encryption only). The only difference is that you will receive a warning. +You can also encrypt this short text while signing, which is equivalent to signing while encrypting. A typical usage +method is to check two key pairs, one is someone else's public key, which is used for encryption; the other is your own +private key, which is used for signing. If you do not check any key that can be used for signing, this is possible ( +equivalent to encryption only). The only difference is that you will receive a warning. - + ## Verify -After obtaining a plaintext and its signature, you can verify the signature. -Whether a key pair can be used for verification will not be displayed in the usage column, you only need to remember a valid public key can be used for verificationWhether a key pair can be used for verification will not be displayed in the usage column, you only need to remember a valid public key can be used for verification. +After obtaining a plaintext and its signature, you can verify the signature. Please keep in mind that this form of +signature is not suitable for use in emails as it will make the email less readable, if you need to sign your email, +please use the "New Message" function to generate the OpenPGP/MIME format sign for your email. + + + +To verify a signature with text, you need to have the corresponding public key for all included signatures. If a +suitable public key for a signature is not found locally during verification, Gpg Frontend will remind you to import it. - + ## Verify With Decrypt After obtaining a ciphertext, you can try to verify it while decrypting it. This is a good habit regardless of whether -the encryptor has signed in advance. -Whether a key pair can be used for decryption will not be displayed in the usage column. You only need to remember that a valid private key can be used to decrypt the ciphertext encrypted with the related public key. +the encryptor has signed in advance. Because you cannot infer from the format of the ciphertext whether it has been +signed or not. So, use decryption operations with verification whenever possible. - + diff --git a/manual/manual/understand-interface.md b/manual/manual/understand-interface.md index f037ad57..fcbc269c 100644 --- a/manual/manual/understand-interface.md +++ b/manual/manual/understand-interface.md @@ -1,40 +1,58 @@ # Understand Interface -As a novice, you only need to quickly grasp the meaning of a few important parts of the page. You will gradually discover other functions in the next exploration. The interface may not be the same for different versions. +As a novice, you only need to quickly grasp the meaning of a few important parts of the page. You will gradually +discover other functions in the next exploration. The interface may not be the same for different versions.  ## Text Editor -In the text editing area, you can type text at will. Or create a new tab through the New option in the top file menu. Tabs can be moved, closed, and so on. +In the text editing area, you can type text at will. Or create a new tab through the New option in the top file menu. +Tabs can be moved, closed, and so on. -You can operate your text through the options in the Operations Bar. Or you can use some common shortcuts(ctrl+c/v/s) to copy-paste save or even find operations. +You can operate your text through the options in the Operations Bar. Or you can use some common shortcuts(ctrl+c/v/s) to +copy-paste save or even find operations. -The text edited in the text box is UTF8 encoded and does not have any formatting. Not providing any formatting (plain text) ensures that the reality of redaction in a message is not confusing. I plan to join rich text editors in the future, but the details are still under consideration. +The text edited in the text box is UTF8 encoded and does not have any formatting. Not providing any formatting (plain +text) ensures that the reality of redaction in a message is not confusing. I plan to join rich text editors in the +future, but the details are still under consideration. ### Large text file support -Here, GpgFrontend supports opening some of the larger files without being stuck. However, when opening a relatively large file, you cannot edit this tab until the file has been totally read. Although this will make you unable to edit the file, you can still view it. +Here, GpgFrontend supports opening some of the larger files without being stuck. However, when opening a relatively +large file, you cannot edit this tab until the file has been totally read. Although this will make you unable to edit +the file, you can still view it. ## Information Board -The result of your operation on the current tab page will be printed in the Information Board: success or failure. In addition to the success and failure information, its text will also contain other information to help you understand the details of your encryption, decryption, signature and other operations. Depending on your language settings, the output in the dashboard will vary. +The result of your operation on the current tab page will be printed in the Information Board: success or failure. In +addition to the success and failure information, its text will also contain other information to help you understand the +details of your encryption, decryption, signature and other operations. Depending on your language settings, the output +in the dashboard will vary. -I used the information board as a solution to be able to display more information in the same space. In the future, a graphical interface display of this information will be introduced, which can help users understand the actual role of this information. +I used the information board as a solution to be able to display more information in the same space. In the future, a +graphical interface display of this information will be introduced, which can help users understand the actual role of +this information. ### Font Color -- **Green**: When the operation succeeds and the results of the operation are verified and no problems are found, the font color will be green. -- **Yellow**: When the operation succeeds and there are some problems with the result testing of the operation at that time, the font turns yellow, which is a reminder to the user. At this time, the user needs to check the details of the operation. -- **Red **: When the operation is unsuccessful or there is a serious conflict with the result of the operation, the font color will turn red, and the user will need to carefully check the details of the operation to ensure security. +- **Green**: When the operation succeeds and the results of the operation are verified and no problems are found, the + font color will be green. +- **Yellow**: When the operation succeeds and there are some problems with the result testing of the operation at that + time, the font turns yellow, which is a reminder to the user. At this time, the user needs to check the details of the + operation. +- **Red**: When the operation is unsuccessful or there is a serious conflict with the result of the operation, the font + color will turn red, and the user will need to carefully check the details of the operation to ensure security. ### Font Size -When you feel that the font of the information board is too small, you can set the font size in the Application column of the settings. The font size defaults to 10 and can be set to a range of between 9 and 18. +When you feel that the font of the information board is too small, you can set the font size in the Application column +of the settings. The font size defaults to 10 and can be set to a range of between 9 and 18. ### Information Board Actions Menu -The dashboard actions menu provides some commonly used actions for information board content. This enables users to quickly record large pieces of content in the Information Board for other uses. +The dashboard actions menu provides some commonly used actions for information board content. This enables users to +quickly record large pieces of content in the Information Board for other uses. #### Copy @@ -42,27 +60,38 @@ This enables users to quickly record large pieces of content in the Information #### Save File -The operation stores the contents of the information board in the file system in UTF-8 format. Although the output file does not have a suffix name, in fact this file is in plain text format. +The operation stores the contents of the information board in the file system in UTF-8 format. Although the output file +does not have a suffix name, in fact this file is in plain text format. #### Clear -This action immediately empties the information board. The empty operation includes the contents of the information board and all the statuses. The emptying operation occurs automatically when you make the next operation (encryption, etc.). +This action immediately empties the information board. The empty operation includes the contents of the information +board and all the statuses. The emptying operation occurs automatically when you make the next operation (encryption, +etc.). ### Optional Actions Menu -There will also be a column of Optional Actions Menu below the Information Board. If there are other auxiliary operations that can be done after your operation is completed (display more detailed information, send encrypted text through email, etc.), the entry points for these auxiliary operations will be displayed here. +There will also be a column of Optional Actions Menu below the Information Board. If there are other auxiliary +operations that can be done after your operation is completed (display more detailed information, send encrypted text +through email, etc.), the entry points for these auxiliary operations will be displayed here. ## Key ToolBox -Here is a list of key pairs stored on your machine that can be used for Gpg operations. The key lists in the Toolbox have multiple categories that correspond to different usage scenarios. The toolbox also provides some commonly used operations, all of which are in the Key List Menu. +Here is a list of key pairs stored on your machine that can be used for Gpg operations. The key lists in the Toolbox +have multiple categories that correspond to different usage scenarios. The toolbox also provides some commonly used +operations, all of which are in the Key List Menu. ### Usage -Most operations related to Gpg need to specify a key pair (such as encryption, decryption, signature, etc.). You can select the check box in the first column of the table in the key toolbox to specify one or more keys for your operation. Classifications that contain only public keys are often used in cryptographic scenarios. +Most operations related to Gpg need to specify a key pair (such as encryption, decryption, signature, etc.). You can +select the check box in the first column of the table in the key toolbox to specify one or more keys for your operation. +Classifications that contain only public keys are often used in cryptographic scenarios. ### Classification -The Toolbox provides a categorical display through tabs. All classifications do not include all expired or revoked keys. If you want to view expired or revoked keys, use the Key Manager. The default classification contains all private and public keys. The operation takes only the key from the currently selected classification as input. +The Toolbox provides a categorical display through tabs. All classifications do not include all expired or revoked keys. +If you want to view expired or revoked keys, use the Key Manager. The default classification contains all private and +public keys. The operation takes only the key from the currently selected classification as input. ### Columns @@ -77,6 +106,8 @@ It is important to understand this list. Now let me take you to understand it st combine the usage column to determine this). - `pub/sec#` The key pair contains a public key and a private key, but the primary key is not in the key pair. This shows that you will not be able to do some special (add subkeys, sign other key pairs, etc.) + - `pub/sec^` A key pair has one or more keys (subkeys or master keys) in the smart card. + - `pub/sec#^`The above two situations occur at the same time. - Name: The identity information of the key pair. - Email Address: The identity information of the key pair. - Usage: This determines which operations the key pair can use. Composed of four capital letters, each capital letter @@ -85,15 +116,19 @@ It is important to understand this list. Now let me take you to understand it st - `E` Encrypt. The key pair can be used for encryption operations. - `S` Sign. The key pair can be used for sign operations. - `A` Authenticate. The key pair can be used to perform operations like SSH authentication. - + - Validity: One of the concepts of Gpg, simply put it represents the degree of trust in this key. ## Operations Bar -Here, you can perform corresponding operations by clicking the buttons above. For example, after typing text in a text editor and setting the key you want to use in the key toolbox, you can click the encryption button to perform the operation. +Here, you can perform corresponding operations by clicking the buttons above. For example, after typing text in a text +editor and setting the key you want to use in the key toolbox, you can click the encryption button to perform the +operation. -Some operations need to specify the key, and some are not used, which will be explained in other corresponding parts of the document. +Some operations need to specify the key, and some are not used, which will be explained in other corresponding parts of +the document. ### Customize -Some operations you may not use for a long time, at which point you can uncheck the relevant function group in the view of the top menu. Conversely, for some of the operations you use frequently, you can also add here.
\ No newline at end of file +Some operations you may not use for a long time, at which point you can uncheck the relevant function group in the view +of the top menu. Conversely, for some of the operations you use frequently, you can also add here.
\ No newline at end of file diff --git a/manual/manual/view-keypair-info.md b/manual/manual/view-keypair-info.md index b9f1ac0b..008f8d37 100644 --- a/manual/manual/view-keypair-info.md +++ b/manual/manual/view-keypair-info.md @@ -5,10 +5,20 @@ information about the key pair. This part may involve a brief introduction to gpg-related concepts, and it will be relatively long. - +The screenshot below is my friend's public key that I got from the key server. + + + +Below is a private key I randomly generated. You can find that the biggest difference between him and the above is that +the key pair with only the public key is only used for encryption, and if you have the private key, you can do more +things (it also depends on your algorithm, DSA can only for signature). + + ## General Info +This interface provides some useful information to assist you in proper management of the key pair. + ### Owner Through this section, you can understand the owner of this key pair. This information is not fixed and unchangeable. You @@ -16,28 +26,37 @@ can create a new UID in the UID section and set it as the main UID to change it. According to the OpenPGP protocol, this part is divided into Name, Email, and Comment. - + -### primary key +### Primary key This part is the information of the primary key of the key pair. The primary key is very important, because without it, the key pair cannot perform related management operations such as adding and revoking sub-keys (similar to the key ring -cannot be opened). Let's introduce the information of the primary key separately below. +cannot be opened). Let's introduce the information of the primary key separately below. If you want to learn more, see +the [Basic Concepts](../basic-concepts.md) section. + +The absence of the master key means that the private key of the master key does not exist, but neither the public key +nor the private key exists. Please remember: Each subkey and primary key consists of a pair of public and private keys. - + #### Key ID -The unique identifier of the primary key is fixed and unchanging. +The unique identifier of the key is fixed and unchanging. Note that this key ID is the key ID of the primary key. The +key ID is uniquely determined after the key is generated. Compared with the fingerprint, the key ID will be shorter and +more user-friendly. #### Algorithm -The encryption algorithm used by the primary key. +Algorithm used for key generation. Note that this also refers to the generation algorithm of the primary key. The +generation algorithm determines the properties and capabilities of the key. Algorithms such as RSA can be used for +encryption and signature, but DSA can only be used for signature, but the DSA key length can be shorter. #### Key Size The length of the primary key. It can be said that the longer the key, the harder it is to crack the ciphertext, but at -the same time, the more time it takes for a single operation. Generally speaking, a length of 2048 bits is safe enough. +the same time, the more time it takes for a single operation. Generally speaking, a length of 2048 bits is safe enough ( +This refers to the key generated using the RSA algorithm). #### Normal Usage @@ -57,7 +76,7 @@ the signature purpose will not be displayed here. The expiration time of the primary key. When the primary key expires, it will be invalid. You cannot use it for any operation. In addition, the subkeys in the key pair will also be unavailable. Fortunately, you can change the expiration time of the primary key at any time, or even set it to never expire. The prerequisite for this is that the primary key -exists. +exists in the key pair. #### Last Update @@ -73,41 +92,83 @@ the key pair cannot sign other key pairs. ### Fingerprint - + The fingerprint of the key pair is used for humans to quickly compare whether the key pair is the expected key pair. +This field is unique for all keys in the world. You can absolutely do this with the key ID mentioned above. -### Operations +This also refers to the fingerprint of the primary key. - +## UID Info -This column lists all available operations. +UID is used to identify the key, and this mechanism is mainly used to facilitate human identification. You can compare +the UID to the accompanying name tag on a key ring, indicating who the key ring belongs to. Humans can roughly identify +whether a key pair is what he expected by looking at the UID, but to accurately identify it, fingerprints or key id need +to be compared. A key can have one or more UIDs. A key pair has one and only one primary UID. -## UID Info +The primary UID on the interface is always the first in the list. -UID is used to identify the key, and this mechanism is mainly used to facilitate human identification. Humans can -roughly identify whether a key pair is what he expected by looking at the UID, but to accurately identify it, -fingerprints need to be compared. A key can have one or more UIDs. A key pair has one and only one main UID. + UID has three elements, Name, Email, Comment. The name must be greater than or equal to five characters, and the email must conform to the format. Comment rules are relatively loose. -### Signature +### Signature of UID + +The bottom half of the interface is the signature of the UID you checked in the list of UIDs (not checked in the box). -You can use the primary key of another key pair to sign a UID. When the master UID of a key pair has many valid -signatures attached, it will be more trustworthy than without a valid key pair. +This is a key trust system. The person who gets your public key actually gets a copy of your key ring, but only the +public key and your nameplate are on the key ring. He can sign your brand with his private key, which means he +recognizes your brand and the public key on the entire key ring. He can then upload the keyring with his signature to +the keyserver, and if a lot of people do this one after another, the public key on the keyserver will have a bunch of +signatures. If there are a lot of signatures on the nameplate, it means that many people recognize the public key and +endorse it, so that the public key can be trusted by everyone. + +You can use the primary key of another key pair to sign a UID. In repeating, in general. When the primary UID of a key +pair has many valid signatures attached, it will be more trustworthy than without a valid key pair. ## Subkey Info The sub-key mechanism is an important content of gpg, which enhances flexibility and security, but also brings a certain -degree of complexity, making it difficult for beginners to understand. +degree of complexity, making it difficult for beginners to understand.If you have absolutely no idea about this, you can +refer to the [Basic Concepts](../basic-concepts.md) section first. + + In order to help you understand this concept and get a preliminary grasp, you only need to read the following points: -- A key pair can be compared to a keychain, with a primary key and multiple subkeys (or no subkeys). -- The sub-key can do related operations (such as signing, encryption) when the primary key is not present or cannot. +- A key pair can be compared to a key ring, with a primary key(a pair of public and private keys) and multiple subkeys ( + or no subkeys). +- Each subkey and primary key consists of a pair of public and private keys. +- The sub-key can do relate operations (such as signing, encryption) when the primary key is not present or cannot. - The functions of the sub-keys can overlap. When both sub-keys can be used for signing, the earliest generated one is selected for this operation. - The sub-key can use more algorithms than the primary key, but generally they have the same effect on daily operations. - The disclosure of the subkey only affects the subkey, and the entire key pair is in danger after the disclosure of the primary key. + +The primary key and all subkeys in the key pair are listed on the interface. The first key in the list must be the main +key, regardless of whether it actually exists or not. Some information about the key is listed below. In fact, you can +know by observation that the information of the primary key here is exactly the same as the information of the first +tab. + +### Key In smart card + +Whether it is in the smart card refers to whether the key is moved to the smart card. Moving the key to the smart card +will change the structure of the key and is irreversible. + +### Operations + +In this column, what you can do is different for a key pair that has only a public key or a key pair that includes a +private key. + +Here's what you can do with a public key-only key pair. + + + +And the screenshot below lists what a key pair containing a private key can do. + + + +These operations will be scattered in the documentation to explain in detail. + diff --git a/manual/overview.md b/manual/overview.md index 3b1aee71..197ab7f0 100644 --- a/manual/overview.md +++ b/manual/overview.md @@ -7,42 +7,71 @@ [](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saturneric/GpgFrontend&utm_campaign=Badge_Grade) [](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend?ref=badge_shield) -**GpgFrontend** is a Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free [OpenPGP](https://www.openpgp.org/) Crypto Tool. +**GpgFrontend** is a Powerful, Easy-to-Use, Compact, Cross-Platform, and +Installation-Free [OpenPGP](https://www.openpgp.org/) Crypto Tool. -By using GpgFrontend, you can quickly encrypt and decrypt text or files. Or at the same time as the above operations, you can add your own signature to let others know that this document or this paragraph of text was issued by you. +By using GpgFrontend, you can quickly encrypt and decrypt text or files. Or at the same time as the above operations, +you can add your own signature to let others know that this document or this paragraph of text was issued by you. -Furthermore, it visualizes most of the common operations of gpg commands. It aims to allow ordinary users to quickly use gpg and make professional users more convenient. GpgFrontend supports new features of GnuPG 2.x. +Furthermore, it visualizes most of the common operations of gpg commands. It aims to allow ordinary users to quickly use +gpg and make professional users more convenient. GpgFrontend supports new features of GnuPG 2.x. + +**The corresponding release version for this +Document: [v2.0.4](https://github.com/saturneric/GpgFrontend/releases/tag/v2.0.4)** ## Interface -Note: For different operating system and system style settings, GpgFrontned may look different. +Note: For different operating system and system style settings, GpgFrontend may look different.Documentation can also +vary widely from release to release. Please check the corresponding program release version for the document. - + ## Origin -The GpgFrontend project inherit from a relatively mature but not maintained [gpg4usb](https://www.gpg4usb.org/) project. It inherits the stable, easy-to-use, compact, and installation-free features of gpg4usb, and plans to support some new features of OpenPGP based on it and continue to improve it. +The GpgFrontend project inherit from a relatively mature but not maintained [gpg4usb](https://www.gpg4usb.org/) project. +It inherits the stable, easy-to-use, compact, and installation-free features of gpg4usb, and plans to support some new +features of OpenPGP based on it and continue to improve it. ## Purpose -Let more people all over the world (even if they don't know the command line and programming) can use GnuPG to safely send information to the destination in a safe way. Free software belongs to the common wealth of all mankind, but there are still many people who cannot use these wealth due to the limitation of knowledge and usage habits. We should break this pattern. GpgFrontend is committed to improving the ease of use and intuitiveness of the free software GnuPG, so that more and more people can use it. +Let more people all over the world (even if they don't know the command line and programming) can use GnuPG to safely +send information to the destination in a safe way. Free software belongs to the common wealth of all mankind, but there +are still many people who cannot use these wealths due to the limitation of knowledge and usage habits. We should break +this pattern. GpgFrontend is committed to improving the ease of use and intuitiveness of the free software GnuPG, so +that more and more people can use it. The GpgFrontend project is as open source, and it also insists on using open source codes and libraries. ### Free forever -GpgFrontend will be free forever, and you don't need to worry about being asked to pay a fee to use the software one day. +GpgFrontend will be free forever, and you don't need to worry about being asked to pay a fee to use the software one +day. + +## Source Code + +The original code repository of Gpg Frontend is hosted on the server of Codes Dream, and each submission will be +submitted to the code repository first. You can click [Here](https://global.git.codesdream.com/GpgFrontend.git) to visit +the original code repository and track development progress. + +注意：中国用户请访问[这里](https://git.codesdream.com/GpgFrontend.git) + +### License -## License +GpgFrontend source code is under a GPL-3.0 license, which means that GpgFrontend is free software. You may exercise the +rights set forth in the Licence under the conditions of compliance with the rules of the Licence. -GpgFrontend's own code is under a GPL-3.0 license, which means that GpgFrontend is free software. You may exercise the rights set forth in the Licence under the conditions of compliance with the rules of the Licence. +### Contribution -## Contribution +At the same time, the addition of new functions does not affect the old basic functions. My personal strength is always +limited. GpgFrontend welcomes volunteers to join. You can use the GitHub platform to file an issue, or submit a pull +request. -At the same time, the addition of new functions does not affect the old basic functions. My personal strength is always limited. GpgFrontend welcomes volunteers to join. You can use the GitHub platform to file an issue, or submit a pull request. +You can also submit questions and code contributions by email, please send me problem reports and patches. ## Privacy Guarantee -GpgFrontend has no servers and does not require servers to run. In addition to the public key transfers allowed by the OpenPGP protocol to the public key server unexpectedly, GpgFrontend does not collect and upload any additional information. +GpgFrontend has no servers and does not require servers to run. In addition to the public key transfers allowed by the +OpenPGP protocol to the public key server unexpectedly, GpgFrontend does not collect and upload any additional +information. For users with high security requirements, a version with no Internet access capability will be available in the future.
\ No newline at end of file diff --git a/manual/quick-start.md b/manual/quick-start.md index 2742038a..f3850100 100644 --- a/manual/quick-start.md +++ b/manual/quick-start.md @@ -1,36 +1,57 @@ # Quick Start -Getting started with GpgFrontend is very simple, you only need a few very simple steps. Moreover, it is oriented to all PC platforms. +Getting started with GpgFrontend is very simple, you only need a few very simple steps. Moreover, it is oriented to all +PC platforms. ## Get channels -The current mainstream distribution channel is the Release feature available through GitHub. It's free and accessible to most people in the world, without me having to worry about servers and bandwidth, which allows me to save a lot of money. +The current mainstream distribution channel is the Release feature available through GitHub. It's free and accessible to +most people in the world, without me having to worry about servers and bandwidth, which allows me to save a lot of +money. -When you click on the [download](https://github.com/saturneric/GpgFrontend/releases/latest), you can see such an interface. It identifies the current version number of the latest release, the release date of that version, and so on. +When you click on the [download](https://github.com/saturneric/GpgFrontend/releases/latest), you can see such an +interface. It identifies the current version number of the latest release, the release date of that version, and so on.  -You can see some notable features or fixes for the version in the main text, or if you're a programmer, you can also click change log to get how the source code differs from the previous version. It is worth mentioning that you can see two green tick marks, which represent that I have personally signed up to the source code of the version. This may be important for some people with high security needs. +You can see some notable features or fixes for the version in the main text, or if you're a programmer, you can also +click change log to get how the source code differs from the previous version. It is worth mentioning that you can see +two green tick marks, which represent that I have personally signed up to the source code of the version. This may be +important for some people with high security needs. -Then, if you swipe down, you can see a lot of Assets, which are releases for GpgFrontned for different operating systems. As you can see, the parts of the file name are separated by separators. You need to know that the second section(e.g. 6171479) provides a unique identification number for the version's source code, and when pointing out problems with a version, you need to provide the 7-digit unique identification number of the released version you are using. +Then, if you swipe down, you can see a lot of Assets, which are releases for GpgFrontned for different operating +systems. As you can see, the parts of the file name are separated by separators. You need to know that the second +section(e.g. 6171479) provides a unique identification number for the version's source code, and when pointing out +problems with a version, you need to provide the 7-digit unique identification number of the released version you are +using.  -Files with sig as the suffix are gpg separate signatures for the released version of the file of the same name. You can use gpg to check if the changed file is signed and approved by me. +Files with sig as the suffix are gpg separate signatures for the released version of the file of the same name. You can +use gpg to check if the changed file is signed and approved by me. -Follow your needs or follow the instructions below to click on the name of the corresponding release version to download. +Follow your needs or follow the instructions below to click on the name of the corresponding release version to +download. ## Install & Run -GpgFrontend is cross-platform, which is one of its differences. For your operating system, you'll need to choose different ways to lay out GpgFrontend. It is worth noting that GpgFrontend only supports 64-bit operating systems. Please check your hardware with your operating system. +GpgFrontend is cross-platform, which is one of its differences. For your operating system, you'll need to choose +different ways to lay out GpgFrontend. It is worth noting that GpgFrontend only supports 64-bit operating systems. +Please check your hardware with your operating system. ### Pre-conditions -GpgFrontend runs dependent on the basic features provided by GnuPG, so you need to install GnuPG before you can install GpgFrontend. Why does GpgFronend require users to install GnuPG separately?Starting with GnuPG 2.0, gpg relies on separate modules to do all of its functions. This requires that when using gpg, these modules all need to be in the correct location on your operating system so that the gpg can find them. +GpgFrontend runs dependent on the basic features provided by GnuPG, so you need to install GnuPG before you can install +GpgFrontend. Why does GpgFronend require users to install GnuPG separately?Starting with GnuPG 2.0, gpg relies on +separate modules to do all of its functions. This requires that when using gpg, these modules all need to be in the +correct location on your operating system so that the gpg can find them. -GnuPG is not included by default in some operating systems (e.g. Windows and macOS), so this situation has caused GpgFrontend to be temporarily unavailable in the Apple Store and Microsoft Store. I have plans to launch GnuPG-based version 1.4 in the future, which will enable GpgFrontend users to start using it when they get it. +GnuPG is not included by default in some operating systems (e.g. Windows and macOS), so this situation has caused +GpgFrontend to be temporarily unavailable in the Apple Store and Microsoft Store. I have plans to launch GnuPG-based +version 1.4 in the future, which will enable GpgFrontend users to start using it when they get it. -In general, the latest Linux distributions offer a GnuPG 2.0 environment. You can check by typing `gpg --version` in the command line tool. **In general, it is recommended to install versions of GnuPG 2.1 and above.** +In general, the latest Linux distributions offer a GnuPG 2.0 environment. You can check by typing `gpg --version` in the +command line tool. **In general, it is recommended to install versions of GnuPG 2.1 and above.** ### Windows (No Setup) @@ -50,13 +71,16 @@ In general, the latest Linux distributions offer a GnuPG 2.0 environment. You ca 1. [Download](https://github.com/saturneric/GpgFrontend/releases) `GpgFrontend-*******-x86_64.dmg` 2. Double-Click GpgFrontend.dmg to load it - - macOS will automatically decompress the zip file and then you will be able to see the dmg + - macOS will automatically decompress the zip file and then you will be able to see the dmg 3. Double click and run it. All published app packages have passed Apple's check, which means you can open it directly. 4. If it satisfies you, you can drag it into your Application folder. #### Debian/Ubuntu/CentOS (AppImage) -AppImage is a format used in Linux systems to distribute portable software without the need for superuser privileges to install them. The core idea of AppImage is a file as an application. Each AppImage contains the application and all the files needed for the application to run. In other words, in addition to the underlying components of the operating system itself, AppImage runs without dependency. This is convenient for users. +AppImage is a format used in Linux systems to distribute portable software without the need for superuser privileges to +install them. The core idea of AppImage is a file as an application. Each AppImage contains the application and all the +files needed for the application to run. In other words, in addition to the underlying components of the operating +system itself, AppImage runs without dependency. This is convenient for users. 0. Install gnupg (If you have already followed please skip) - For Debian/Ubuntu @@ -77,16 +101,16 @@ AppImage is a format used in Linux systems to distribute portable software witho ### Debian/Ubuntu (DEB) -With deb, you can easily manage dependencies using the apt tool. Deb packages are small compared to AppImage. +With deb, you can easily manage dependencies using the apt tool. Deb packages are small compared to AppImage. 0. Install gnupg (If you have already followed please skip) - - For Debian/Ubuntu + - For Debian/Ubuntu - ```shell - $ sudo apt update - $ sudo apt install gpg - ``` + ```shell + $ sudo apt update + $ sudo apt install gpg + ``` 1. [Download](https://github.com/saturneric/GpgFrontend/releases) `GpgFrontend-*******-x86_64.deb` diff --git a/manual/translate-interface.md b/manual/translate-interface.md index 36c39b74..0238835c 100644 --- a/manual/translate-interface.md +++ b/manual/translate-interface.md @@ -1,17 +1,22 @@ # Translate Interface GpgFrontend is designed to support multiple languages, but requires volunteer contributions to achieve this goal. -Fortunately, translation work does not require an understanding of difficult technology. Volunteers only need to move their fingers to complete. +Fortunately, translation work does not require an understanding of difficult technology. Volunteers only need to move +their fingers to complete. -There are two ways to translate, through a translation tool with a GUI interface or directly through a text editor. +There are two ways to translate, through a translation tool with a GUI interface or directly through a text editor. ## What you need to know about translation work -From v2.0.1, Gpg Frontend uses the popular translation support library [GNU gettext](https://www.gnu.org/software/gettext/) in the GNU project. Before starting everything, you need to know something about this library. After you are sure about the content of the document, you can first try to see how GpgFrontned uses the tools provided by this library. +From v2.0.1, Gpg Frontend uses the popular translation support +library [GNU gettext](https://www.gnu.org/software/gettext/) in the GNU project. Before starting everything, you need to +know something about this library. After you are sure about the content of the document, you can first try to see how +GpgFrontned uses the tools provided by this library. ### Facts -Most of the translation work is carried out by Google Translate. In most cases, what you have to do is to correct some of the bad aspects of Google Translate. +Most of the translation work is carried out by Google Translate. In most cases, what you have to do is to correct some +of the bad aspects of Google Translate. ## About translation files @@ -21,7 +26,8 @@ Most of the translation work is carried out by Google Translate. In most cases, ## Before starting your work -In order to facilitate coordination, please contact me via email before you start this work. This is very important, please contact me first so that the work you do can be better used by GpgFrontend. +In order to facilitate coordination, please contact me via email before you start this work. This is very important, +please contact me first so that the work you do can be better used by GpgFrontend. ## Hand in your work |
