diff options
Diffstat (limited to 'manual')
| -rw-r--r-- | manual/_navbar.md | 2 | ||||
| -rw-r--r-- | manual/_sidebar.md | 2 | ||||
| -rw-r--r-- | manual/basic-concepts.md | 94 | ||||
| -rw-r--r-- | manual/contract.md | 37 | ||||
| -rw-r--r-- | manual/faq.md | 14 | ||||
| -rw-r--r-- | manual/overview.md | 72 | ||||
| -rw-r--r-- | manual/quick-start.md | 29 |
7 files changed, 120 insertions, 130 deletions
diff --git a/manual/_navbar.md b/manual/_navbar.md index 0a2397f9..80c0b1a3 100644 --- a/manual/_navbar.md +++ b/manual/_navbar.md @@ -1,6 +1,6 @@ <!-- _navbar.md --> -- [Source Code(Develop Repo)](https://git.codesdream.com/?p=public/main/GpgFrontend.git;a=summary) +- [Source Code(Develop Repo)](https://repo.stdv.de/?p=public/main/GpgFrontend.git;a=summary) - [Document](https://doxygen.gpgfrontend.bktus.com) - [Manual](overview.md) - [Downloads](downloads.md) diff --git a/manual/_sidebar.md b/manual/_sidebar.md index f07fb50a..25af0716 100644 --- a/manual/_sidebar.md +++ b/manual/_sidebar.md @@ -2,7 +2,7 @@ - [Overview](overview.md) - [Quick Start](quick-start.md) - [Downloads](downloads.md) - - [Basic concepts](basic-concepts.md) + - [Fundamental Concepts](basic-concepts.md) - Manual - [Understand Interface](manual/understand-interface.md) - [Encrypt & Decrypt Text](manual/encrypt-decrypt-text.md) diff --git a/manual/basic-concepts.md b/manual/basic-concepts.md index 3f7b68e4..7e397d2a 100644 --- a/manual/basic-concepts.md +++ b/manual/basic-concepts.md @@ -1,69 +1,53 @@ -# Basic Concepts +# Fundamental 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. +If you're unfamiliar with GPG or PGP, it would be beneficial to learn some +fundamental concepts before using GpgFrontend. This can help prevent potential +mistakes, such as accidentally sharing your private key. -## The most basic concepts you must know +## Essential Concepts -To begin using GPG, you must first generate a key pair, which can be thought of -as a key ring. Each key pair includes at least two keys: a public key and a -corresponding private key. Together, these keys form a key pair. It is possible -for a key pair to include multiple public keys and their corresponding private -keys, but this will be explained later. +Before you start using GPG, you need to generate a key pair, analogous to a key +ring. Each key pair comprises at least two keys: a public key and a +corresponding private key. It is possible for a key pair to contain multiple +public keys and their associated private keys, which we'll discuss later. -The public key can be shared with others, allowing them to encrypt information -they wish to send to you. The private key must be kept secure, as its disclosure -would render your encryption ineffective. +The public key can be shared with others, allowing them to encrypt data they +want to send you. Conversely, the private key should remain confidential since +its exposure can compromise your encryption. -It is important to understand that the public key is used for encryption and -that any ciphertext encrypted using your public key can only be decrypted using -the corresponding private key of your key pair. This process relies on -cryptographic principles and is trustworthy unless your private key is known to -someone else. The reverse process is also valid: you can encrypt a message using -your private key and someone else can decrypt it using your public key. This -process establishes a mechanism for signing and verifying information. -Information encrypted with the private key can be considered a signature, and -others can use the public key to verify that the signature is valid. +It's vital to understand that the public key is used for encryption, and the +ciphertext encrypted with your public key can only be decrypted using your key +pair's corresponding private key. This process is based on cryptographic +principles and is reliable unless your private key gets compromised. Similarly, +you can encrypt a message with your private key, and someone else can decrypt it +using your public key, establishing a signature verification mechanism. -For most users, it is not necessary to understand the cryptography behind GPG, -but it is helpful to remember the basic principles described above. For those -interested in learning more, further reading is recommended. +While understanding the underlying cryptography of GPG isn't necessary for most +users, remembering these basic principles can be beneficial. -## Multiple pairs of public and private keys in a key pair +## Multiple Pairs of Public and Private Keys in a Key Pair -In a key pair, there is always at least one public-private key pair, but there -is no limit to the maximum number of pairs. It is possible to generate -additional pairs of public and private subkeys and add them to the key pair. -However, it should be noted that the newly added subkeys are identical to the -original pair, as each pair consists of one public key and one private key, -which we refer to as the primary key pair. +A key pair always contains at least one public-private key pair, but there's no +maximum limit. It's possible to generate additional public and private subkeys +to add to the key pair. Each pair consists of one public key and one private +key, which we refer to as the primary key pair. -Users can specify the purpose of each subkey pair. For instance, the first key -pair can be used for encryption and decryption, the second for signing and -verification, and the third for both encryption/decryption and -signing/verification. It is important to specify the intended usage when +Users can specify the purpose of each subkey pair. For instance, the first pair +can be used for encryption and decryption, the second for signing and +verification, and so forth. It's important to define the intended usage when generating subkeys. -The master key is automatically generated when the key pair is created, and -users can add subkeys as needed. +The primary key is automatically generated when creating the key pair, and users +can add subkeys as needed. When generating the primary key or subkeys, users can +select algorithms such as RSA or DSA. -When generating the master key or subkeys, users can select algorithms such as -RSA or DSA. It is not necessary to understand the underlying principles of these -algorithms. However, it is important to note that subkeys generated by certain -algorithms may only perform specific processes, such as signing and -verification, and cannot perform others, such as encryption and decryption. -Additionally, for RSA, users can choose the key length when using the algorithm. +## The First Pair of Public and Private Keys in a Key Pair (Primary Key) -## The first pair of public and private keys in a key pair (primary key) +The initial public-private key pair (primary key) in a key pair is crucial as +all subsequent subkeys are tied to it. If the primary key is compromised, they +could generate subkeys based on that information and impersonate the key owner. -The initial public-private key pair (master key) in a key pair is crucial, as -all subsequent sub-keys are linked to it. If someone were to obtain the master -key (including both the public and private key information), they could generate -sub-keys based on that information and use them to impersonate the key owner and -communicate with others. - -Therefore, it is essential that the private key of the master key is kept -confidential, while the public key can be shared with others. If the private key -of the master key is compromised, it renders the entire key pair vulnerable and -must be immediately discontinued. +Therefore, it's crucial to keep the primary key's private key confidential, +while the public key can be shared. If the private key of the primary key is +compromised, it makes the entire key pair vulnerable and its use should be +immediately discontinued.
\ No newline at end of file diff --git a/manual/contract.md b/manual/contract.md index 19d444f1..20903104 100644 --- a/manual/contract.md +++ b/manual/contract.md @@ -1,36 +1,39 @@ -# Contract +# Contact -We do not accept content related to business and politics on this platform, as -this tool is meant for the benefit of all humanity. However, if you have any -inquiries or suggestions regarding the technology and improvement of this -software, please do not hesitate to contact me. +Please refrain from sharing content related to business and politics on this +platform, as this tool is designed for the betterment of all humanity. However, +if you have any technical questions or suggestions for improving the software, +please feel free to contact me. -Please use plain text to reach out to me via email, as HTML is not preferred. +Preferably, use plain text when reaching out to me via email, as HTML is not +preferred. -## About ME +## About Me -Name: Saturneric, Eric or Erich. +Name: Saturneric, Eric, or Erich. -Email: [[email protected]](mailto:[email protected]) (Hosted in the Federal Republic of Germany) +Email: [[email protected]](mailto:[email protected]) (Hosted in the Federal Republic +of Germany) -Email Content Style: It is recommended to use plain text without HTML style rich text. +Email Content Style: It is recommended to use plain text without HTML style rich +text. -About Domain Name: BKTUS(Bakantu union us) is not a company, it is my personal domain name. +About Domain Name: BKTUS(Bakantu union us) is not a company; it is my personal +domain name. ## Languages -You can write to me in following languages. +You can correspond with me in the following languages: 1. English 2. Chinese -3. Deutsch +3. German (Deutsch) ## GPG Public Key Info -Here is the PGP public key that I have been using for a long time. You can use -this public key to establish secure and encrypted communication with me. Please -use plain text for any encrypted communication and avoid using rich text formats -such as HTML. +Here is my long-term PGP public key. You can use this public key to establish +secure and encrypted communication with me. Please use plain text for any +encrypted communication and avoid using rich text formats such as HTML. ``` -----BEGIN PGP PUBLIC KEY BLOCK----- diff --git a/manual/faq.md b/manual/faq.md index a5e61165..9d474460 100644 --- a/manual/faq.md +++ b/manual/faq.md @@ -3,16 +3,16 @@ ## What is GpgFrontend? GpgFrontend is a cross-platform encryption tool that adheres to the OpenPGP -standard. Its goal is to simplify the use of OpenPGP, making it more accessible -for individuals to protect their privacy. +standard. Its objective is to make the use of OpenPGP simpler, thereby enabling +more individuals to secure their privacy. -## Relationship between OpenPGP(PGP) and GnuPG(GPG)？ +## What's the relationship between OpenPGP(PGP) and GnuPG(GPG)? OpenPGP is a standard for data encryption and decryption, which is supported by -GpgFrontend. GnuPG is a cryptographic software that is used for encrypting, -signing, and managing keys for asymmetric cryptography, and it follows the -OpenPGP standard. GpgFrontend operates GnuPG at runtime to perform various -operations such as encryption and decryption. +GpgFrontend. GnuPG is a cryptographic software that's used for encryption, +signing, and key management for asymmetric cryptography, and it follows the +OpenPGP standard. GpgFrontend utilizes GnuPG during its operation to perform +various tasks such as encryption and decryption. ## How to obtain and use GpgFrontend? diff --git a/manual/overview.md b/manual/overview.md index 91511445..b87f20f8 100644 --- a/manual/overview.md +++ b/manual/overview.md @@ -46,8 +46,8 @@ aligns with the recommended configurations. ### Operating System GpgFrontend is compatible with major operating systems including Linux, macOS, -and Windows. Specifically, it recommends Windows 10 and later, macOS 10.15 High -Sierra and later, and Ubuntu 18.04 LTS or other equivalent Linux distributions. +and Windows. Specifically, it recommends Windows 10 and later, macOS 11 and +later, and Ubuntu 20.04 LTS or other equivalent Linux distributions. ### Software Dependencies @@ -95,53 +95,53 @@ support some new features of OpenPGP based on it and continue to improve it. ## Purpose -The aim of GpgFrontend is to enable people worldwide, even those without command -line or programming experience, to safely transmit information to their desired -destination. Although free software is a common asset for all humankind, there -are still many individuals who are unable to benefit from it due to their -limited knowledge and usage habits. We need to break this cycle. GpgFrontend is -dedicated to enhancing the ease-of-use and intuitiveness of the free software -GnuPG, with the ultimate goal of making it accessible to a broader audience. +GpgFrontend is committed to empowering people globally, especially those without +command-line or programming expertise, to securely transmit information. While +free software represents a shared asset for all of humanity, many individuals +remain unable to leverage it due to limited knowledge or ingrained usage habits. +Our mission is to break this cycle. -The GpgFrontend project is as open source, and it also insists on using open -source codes and libraries. +We are dedicated to improving the user-friendliness and intuitive nature of the +free software GnuPG, with the primary objective of expanding its reach to a +wider audience. + +As an open-source project, GpgFrontend not only advocates for transparency and +community participation, but also adheres to 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 is committed to remaining free of charge indefinitely. You can rest +assured that you will never be asked to pay a fee to use the software. ## 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://git.codesdream.com/?p=public/main/GpgFrontend.git;a=summary) to -visit the original code repository and track development progress. +The primary code repository for GpgFrontend resides on the BKTUS server. +Every update gets committed here first. You can visit the original [code +repository](https://repo.stdv.de/?p=public/main/GpgFrontend.git;a=summary) to +follow our development progress and stay updated on the latest changes. -注意：中国用户请访问[这里](https://git.codesdream.com/main/GpgFrontend.git) ### License -The source code for GpgFrontend is licensed under the GPL-3.0 license, which -ensures that GpgFrontend is open-source software. You have the right to exercise -the rights specified in the license, subject to compliance with the terms of the -license. +GpgFrontend's source code is licensed under the GPL-3.0 license, affirming its +status as open-source software. You are entitled to exercise the rights outlined +in the license, as long as you adhere to its terms and conditions. -### Contribution +### Contributing -Furthermore, the addition of new features does not compromise the existing core -functionality. As an individual, my capabilities are limited. Therefore, -GpgFrontend welcomes volunteers to contribute to the project. You can file -issues or submit pull requests through the GitHub platform. Additionally, you -can submit your questions and code contributions via email. Please feel free to -send problem reports and patches to me. +We believe that adding new features shouldn't compromise existing core +functionality. However, as an individual developer, my abilities are limited. +Therefore, GpgFrontend warmly welcomes contributors. You can report issues or +submit pull requests through GitHub. Additionally, questions and code +contributions can be submitted via email. Feel free to send me your bug reports +and patches. -## Privacy Guarantee +## Privacy Assurance -GpgFrontend operates without servers, and does not require servers to be -operational. While it utilizes the OpenPGP protocol for public key transfers, it -does not collect or upload any additional information. +GpgFrontend operates serverlessly, it doesn't require any server to function. +Although it utilizes the OpenPGP protocol for public key transfers, no +additional information is collected or uploaded. -For users with elevated security requirements, a version of GpgFrontend will be -available in the future which will not have internet access capability. +For users with heightened security needs, a version of GpgFrontend will be made +available in the future that lacks internet access capabilities. diff --git a/manual/quick-start.md b/manual/quick-start.md index b898005e..ecba884b 100644 --- a/manual/quick-start.md +++ b/manual/quick-start.md @@ -1,22 +1,25 @@ -# Quick Start +# Getting Started -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. +One of the unique features of GpgFrontend is its cross-platform capability. +Depending on your operating system, the installation process might vary. -## Pre-conditions +## Prerequisites -**For Windows users or macOS users using Homebrew, you can just skip this section.** +**If you are a Windows or macOS user with Homebrew, you can skip this section.** -GpgFrontend runs dependent on basic functions provided by GnuPG, so you need to install GnuPG before you can run -GpgFrontend. Why does GpgFrontend 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 relies on the basic functions provided by GnuPG. Hence, it is +necessary to install GnuPG before running GpgFrontend. Starting from GnuPG 2.0, +GPG operates based on separate modules for all its functionalities. For GPG to +operate smoothly, these modules must be correctly situated within your operating +system. -GnuPG is not be able to run in App Sandbox, so this situation has caused GpgFrontend to be temporarily unavailable -in the Apple Store. I have tried for many times to bundle GnuPG into App Sandbox, but eventually failed. +Unfortunately, GnuPG cannot operate within an App Sandbox, which is why +GpgFrontend is currently not available on the Apple Store. I have attempted +multiple times to integrate GnuPG into the App Sandbox but to no avail. -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.** +By default, most latest Linux distributions come with a GnuPG 2.0 environment. +You can verify this by entering `gpg --version` in the command line tool. **As a +general recommendation, you should install versions of GnuPG 2.2 or higher.** ## Install & Run Steps |