diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | manual/_navbar.md | 2 | ||||
| -rw-r--r-- | manual/features/introduce.md | 46 | ||||
| -rw-r--r-- | manual/features/sync-all-public-keys.md | 36 | ||||
| -rwxr-xr-x | manual/manual/sign-verify-file.md | 67 | ||||
| -rw-r--r-- | manual/manual/sign-verify-text.md | 81 | ||||
| -rw-r--r-- | manual/manual/symmetric-encrypt-decrypt-text.md | 11 | ||||
| -rw-r--r-- | manual/manual/understand-interface.md | 234 | ||||
| -rw-r--r-- | manual/manual/view-keypair-info.md | 209 | ||||
| -rw-r--r-- | manual/quick-start.md | 148 |
10 files changed, 435 insertions, 401 deletions
@@ -33,7 +33,7 @@ GpgFrontend is **PERMANENTLY FREE** of charge. However, you can support us by [>> Download <<](https://github.com/saturneric/GpgFrontend/releases/latest) | [>> User Manual <<](https://www.gpgfrontend.bktus.com/#/overview) | [>> Developer Document <<](https://doxygen.gpgfrontend.bktus.com/) -| [>> Develop Code Repo <<](https://repo.stdv.de/?p=public/main/GpgFrontend.git;a=summary) +| [>> Develop Repo <<](https://git.bktus.com/gpgfrontend/GpgFrontend) ## Table of Contents diff --git a/manual/_navbar.md b/manual/_navbar.md index 5af344e6..ab9b6b7b 100644 --- a/manual/_navbar.md +++ b/manual/_navbar.md @@ -1,6 +1,6 @@ <!-- _navbar.md --> -- [Source Code(Develop Repo)](https://git.bktus.com/gpgfrontend/GpgFrontend) +- [Source Code(Develop)](https://git.bktus.com/gpgfrontend/GpgFrontend) - [Document](https://doxygen.gpgfrontend.bktus.com) - [Manual](overview.md) - [Downloads](downloads.md) diff --git a/manual/features/introduce.md b/manual/features/introduce.md index 00eb5e21..c0cb5a36 100644 --- a/manual/features/introduce.md +++ b/manual/features/introduce.md @@ -1,5 +1,45 @@ -# Introduce Features +# Introduce Features GpgFrontend provides some advanced functions that can meet the needs of certain -scenarios. These features will be gradually introduced as the version is -updated. +scenarios. + +1. **Encryption and Decryption**: You can encrypt files or texts using + GpgFrontend, which will make your files unreadable to anyone without the + corresponding key to decrypt them. This is useful for securing sensitive + data. Similarly, you can decrypt files or texts encrypted with your public + key. + +2. **Digital Signing and Verification**: GpgFrontend allows you to digitally + sign your files or text. A digital signature is a mathematical scheme for + demonstrating the authenticity of a digital message or document. Similarly, + if someone sends you a signed message or document, you can verify the + signature to ensure it hasn't been tampered with and confirm the identity of + the sender. + +3. **Key Management**: GpgFrontend enables you to manage all your GPG keys + conveniently. You can generate, export, import, revoke, and edit your keys. + It also offers a simple interface for managing your keyring, including your + public and private keys. + +4. **Cross-Platform Compatibility**: One of the best features of GpgFrontend is + its ability to run on multiple platforms, including Windows, Linux, and + macOS. This means you can use it no matter what operating system you're + using, making it an extremely versatile tool. + +5. **Open-Source**: Being open-source, GpgFrontend gives you the flexibility to + modify and distribute the software. This ensures that the software can be + trusted, as anyone can verify what exactly the software does. + +6. **Keyserver Interaction**: GpgFrontend allows for interactions with + keyservers, facilitating easy sharing of public keys. + +7. **User-Friendly Interface**: The software offers an intuitive graphical user + interface (GUI), making it easier for users to navigate through the software + and perform tasks. + +8. **Compatibility with GnuPG**: GpgFrontend is designed to be a GUI frontend + for modern GnuPG, meaning it can handle all operations compatible with GnuPG. + +These are the primary features as of the current version. As GpgFrontend +continues to evolve, additional features may be added to enhance its +capabilities and user experience.
\ No newline at end of file diff --git a/manual/features/sync-all-public-keys.md b/manual/features/sync-all-public-keys.md index 00f09c9b..b0175999 100644 --- a/manual/features/sync-all-public-keys.md +++ b/manual/features/sync-all-public-keys.md @@ -1,30 +1,30 @@ # 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. +Maintaining the synchronization of your local key with the one on the key server +is of paramount importance in certain situations. Such scenarios may include the +revocation of a key by its owner, necessitating the immediate discontinuation of +its use to prevent potential man-in-the-middle attacks. Alternatively, if the +key owner generates a new signing subkey, gpg won't be able to authenticate the +validity of the encrypted text if it's signed with the subkey and you lack the +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. +The utilization of this feature is straightforward. By clicking the Sync Public +Key button in the Key Management interface, the process is automated.  -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. +This functionality checks all the public keys you currently possess (only public +keys, no private keys are involved). It then seeks it on the key server. If the +corresponding public key is found on the server, GpgFrontend imports the updated +public key from the server to the local machine. -### Which Key Server Was Used +### Key Server Utilized -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. +How do you determine which key server GpgFrontend accessed? It's quite simple. +GpgFrontend exchanges keys using the default key server that you've configured. +If you need to modify the key server you wish to access, you merely need to add +your key server in the settings and set it as the default.  diff --git a/manual/manual/sign-verify-file.md b/manual/manual/sign-verify-file.md index 5c770596..2679e6c4 100755 --- a/manual/manual/sign-verify-file.md +++ b/manual/manual/sign-verify-file.md @@ -1,56 +1,59 @@ -# Sign & Verify File +# Signing & Verifying Files -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. +Gpg Frontend offers a convenient and efficient method for file operations. The +concept of signing and verifying files is almost identical to text, with the key +difference being that the file operations' input and output can be binary. -## File Extension Introduction +## Introduction to File Extensions -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. +For ASCII-formatted ciphertext, the filename suffix is usually "asc", and these +files can be opened directly with a text editor. However, if the ciphertext is +binary, its file extension will be "sig" or "gpg". Typically, binary ciphertext +files are smaller than ASCII-formatted ones. -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. +Prior to v2.0.4, the ciphertext files generated by GpgFrontend were all in ASCII +format. But starting with v2.0.4, GpgFrontend defaults to generating +binary-formatted ciphertext files. You can modify this setting in the 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. +You can open the file browser (Ctrl/Command + B) via the top menu file option. +Using the file browser, navigate to your working directory. Then, right-click +the file you wish to operate on, and select the desired operation from 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. +Two control buttons are located at the top of the file tab. The one on the left +allows you to go up a level, and the one on the right enables you 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. +On the far right is a button offering useful options, such as displaying 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 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. +Through the right-click menu, you can rapidly sign a file. This operation will +generate a file with a "sig" or "asc" suffix, which contains the signature +content. In this scenario, you need to pass both this file and the original file +to the other party to allow them to verify it. - + ### Verify -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. +This operation requires you to select a file with a "gpg" suffix (this may be +invalid for binary file ciphertext) 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. +When selecting a file with the "sig" suffix, ensure that the source file is also +present in this directory. This implies that the source file's name is simply +missing a "sig" suffix. -
\ 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 82811773..eb7918f1 100644 --- a/manual/manual/sign-verify-text.md +++ b/manual/manual/sign-verify-text.md @@ -1,60 +1,61 @@ -# Sign & Verify Text +# Signing & Verifying Text -The process of signing and verifying is typically the inverse of the process of -encryption and decryption. When signing, the private key is used, and when -verifying, the public key is used. Similar to signing multiple names on a -document, multiple private keys can be selected when signing. However, there are -some notable differences. Digital signatures can be used to verify whether the -signature's content has been tampered with, while it is difficult to achieve the -same level of verification with handwritten signatures. +The process of signing and verifying generally corresponds to the process of +encryption and decryption. For signing, the private key is used, and for +verifying, the public key is utilized. Similar to signing a document with +multiple signatures, you can choose multiple private keys during the signing +process. However, there are key differences. Digital signatures enable us to +check whether the signed content has been altered, which is difficult to achieve +with handwritten signatures. -## Only Sign +## Signature Only -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. +By signing the text, you establish that you are the sole and unalterable +authority for this text. You can simply sign the text without encrypting it as +follows: - + -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 a key can be used for signing, please review the 'Usage' column +in the key toolbox on the right (the letter 'S' stands for signature). -## Sign With Encrypt +## Signature with Encryption -You can also perform signing and encryption simultaneously by selecting both a -public key for encryption and your own private key for signing. This is a common -practice where you check two key pairs: one belonging to someone else for -encryption, and the other being your own private key for signing. If you do not -select any key for signing, encryption-only is possible, but you will receive a -warning. It is worth noting that combining signing and encryption provides an -additional layer of security, as it ensures the recipient that the message has -not been tampered with and that it came from the sender whose identity is -verified by the digital signature. +You also have the option to sign and encrypt at the same time by choosing a +public key for encryption and your private key for signing. This is a common +practice where you select two key pairs: one belonging to someone else for +encryption, and your private key for signing. If you don't select a key for +signing, only encryption is possible, but you will receive a warning. It's worth +noting that combining signing with encryption provides an additional layer of +security as it assures the recipient that the message hasn't been altered and it +came from the sender whose identity is verified by the digital signature.  -## Verify +## Verification -Once you have obtained a plaintext and its corresponding signature, you can -verify the signature using the public key of the signer. However, please note -that this form of signature is not suitable for use in emails as it can make the -email less readable. +Once you have a plaintext and its corresponding signature, you can verify the +signature using the signer's public key. However, this type of signature isn't +suitable for emails as it can make the email less readable. - + 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, GpgFrontend will remind you to import it. +for all included signatures. If a suitable public key for a signature isn't +found locally during verification, GpgFrontend will prompt you to import it.  -## Verify With Decrypt +## Verification with Decryption -It is recommended to verify a ciphertext while decrypting it, regardless of -whether it has been signed by the encryptor or not. It is not possible to -determine from the format of the ciphertext whether it has been signed or not. -Therefore, it is a good habit to always use decryption operations with -verification when possible. +When decrypting a ciphertext, it's advised to verify it simultaneously, +regardless of whether the encryptor signed it or not. It's impossible to +determine from the ciphertext's format if it has been signed. Therefore, it's a +good habit to always perform decryption operations with verification whenever +possible. - + diff --git a/manual/manual/symmetric-encrypt-decrypt-text.md b/manual/manual/symmetric-encrypt-decrypt-text.md index 7b605a62..63637737 100644 --- a/manual/manual/symmetric-encrypt-decrypt-text.md +++ b/manual/manual/symmetric-encrypt-decrypt-text.md @@ -1,6 +1,7 @@ -# Symmetric Encrypt & Decrypt Text +# Symmetric Encryption & Decryption of Text -Symmetric encryption will be triggered when you click the Encrypt button and do -not check any key in the Key Toolbox. For symmetric encryption, you need to set -a password for your encryption process. When decrypting, you need to enter the -same password as the encryption process.
\ No newline at end of file +Symmetric encryption is initiated when you click the 'Encrypt' button without +selecting any key in the Key Toolbox. For this type of encryption, a password +must be established for the encryption process. Subsequently, to decrypt the +data, you will need to provide the same password that was used during the +encryption phase.
\ No newline at end of file diff --git a/manual/manual/understand-interface.md b/manual/manual/understand-interface.md index e1ce09bb..31e3ed64 100644 --- a/manual/manual/understand-interface.md +++ b/manual/manual/understand-interface.md @@ -1,167 +1,175 @@ -# Understand Interface +# Interface Understanding -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 beginner, you're only required to swiftly comprehend a few crucial sections +of the page. The exploration that follows will gradually unveil additional +functionalities. Bear in mind that interfaces may vary across different +versions.  ## Text Editor -In the text editing area, you are free to type any text you want, or create a -new tab using the "New" option in the file menu at the top. You can easily move -or close tabs as needed. +The text editing zone allows you the liberty to input any desired text or +establish a new tab through the "New" choice in the file menu at the top. Moving +or closing tabs can be done with ease as per your needs. -You can perform various operations on your text using the options provided in -the Operations Bar, or you can use common shortcuts like Ctrl+C/V/S to copy, -paste, and save or even find operations. +Numerous operations can be performed on your text using options available in the +Operations Bar. Alternatively, you may utilize standard shortcuts like +Ctrl+C/V/S for copy, paste, and save operations, or even searching within the +text. -The text you edit in the text box is encoded in UTF8 and has no formatting. This -plain text format ensures that any redacted message is not confusing. Although -we plan to add rich text editing in the future, the details are still under -consideration. +The edited text within the text box is encoded in UTF8 without any formatting. +This plain text format ensures that no message alteration leads to confusion. +While we have plans to introduce rich text editing in the future, the specifics +are still being deliberated. -### Large text file support +### Large Text File Support -GpgFrontend provides support for opening larger files without getting stuck. -However, when opening a relatively large file, you will not be able to edit the -tab until the entire file has been read. Even though editing the file is not -possible during this time, you can still view it. +GpgFrontend accommodates opening larger files without hindrance. However, when +dealing with relatively large files, editing of the tab won't be feasible until +the entire file is loaded. During this time, despite not being able to edit the +file, you still have the capability to view it. ## Information Board -GpgFrontend displays the result of your current tab page operation in the -Information Board, indicating whether the operation was successful or not. The -text in the Information Board also includes additional information to help you -understand the specifics of your encryption, decryption, signature, and other -operations. The output displayed in the dashboard may vary based on your -language settings. +GpgFrontend presents the outcome of the current tab page operation on the +Information Board, signifying the success or failure of the operation. +Additionally, the Information Board's text includes supplementary details to +assist in understanding the particulars of your encryption, decryption, +signature, and other operations. Depending on your language settings, the output +displayed on the dashboard may differ. -The Information Board was created to allow for the display of more information -in the same space. However, in the future, GpgFrontend plans to introduce a -graphical interface to enhance the user's understanding of this information. +The Information Board was conceived to provide a comprehensive view of more +information within the same space. However, GpgFrontend plans to incorporate a +graphical interface in the future to augment the user's comprehension of this +information. -### Font Color +### Color Coding -- **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**: Indicates a successful operation that has been thoroughly verified + and found devoid of any issues. The appearance of green font color signifies + an all-clear. +- **Yellow**: Denotes a successful operation with some potential issues detected + during result testing. The yellow font color serves as a subtle alert for the + user, necessitating a detailed review of the operation. +- **Red**: Symbolizes an unsuccessful operation or a significant discrepancy in + the operation's outcome. The red font color acts as a clear warning, demanding + the user to meticulously inspect the operation's specifics to ensure security. -### Font Size +### Customizable 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. +Should you find the font size on the information board to be diminutive, you can +easily adjust it under the 'Application' section in the settings. The default +font size is 10, and it can be modified to any value ranging from 9 to 18. -### Information Board Actions Menu +### Dashboard 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 facilitates quick and easy access to common +functionalities related to the content of the information board. It empowers +users to efficiently manage and process large chunks of content on the +Information Board for various purposes. #### Copy -This enables users to quickly record large pieces of content in the Information -Board for other uses. +This function allows users to swiftly capture significant portions of content +from the Information Board for other applications. #### 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. +This operation archives the contents of the information board into the file +system, utilizing the UTF-8 format. Although the resultant output file lacks a +suffix, it is essentially in a 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 command promptly purges all content from the information board. The +clearance includes both the contents and statuses of the information board. A +new operation (such as encryption) will automatically trigger this clearing +process. ### 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. +In addition to the Information Board, an Optional Actions Menu will be presented +below it. If any auxiliary operations can be performed post your main operation +(such as displaying more detailed information, sending encrypted text via email, +etc.), the access points for these supplementary tasks will be made available +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. +This feature presents a comprehensive list of key pairs stored on your device, +intended for use with Gpg operations. The keys within the ToolBox are classified +into multiple categories, each corresponding to a unique usage context. +Additionally, the ToolBox provides access to a variety of common operations, all +of which can be found 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 Gpg-related operations require specifying a key pair (for tasks like +encryption, decryption, signature, etc.). You can select the checkbox in the +first column of the Key ToolBox's table to designate one or more keys for your +operation. Categories that contain only public keys are frequently utilized 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 showcases categories via tabbed display. None of these categories +include any expired or revoked keys. To view such keys, you should refer to the +Key Manager. The default category comprises all private and public keys. During +any operation, only the keys from the currently selected category will be +considered for input. ### Columns -It is important to understand this list. Now let me take you to understand it -step by step. +Understanding this list is crucial. Let's walk through its components step by +step. -- Select: Turn the checkbox in this column to let Gpg Frontend know that you - specify the key of this row for your next operation. +- **Select**: Check the box in this column to notify Gpg Frontend that you wish + to use the key from this row for your subsequent operation. -- Type: See this column to let you know the type of key and whether the primary +- **Type**: This column informs you about the key type and whether the primary key exists in your key pair. - - `pub` means this is a public key, Can be used for encryption or + - `pub` signifies that it is a public key, which can be used for encryption or verification operations. - - `pub/sec` The key pair contains both public and private keys. It can be - used for almost all operations(Need to 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 represents a usage. - - - `C` Certificate. Generally, the key pair that contains the primary key - will have this usage - - `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. + - `pub/sec` indicates that the key pair contains both public and private keys. + It can be employed for nearly all operations (consult the 'Usage' column to + confirm this). + - `pub/sec#` shows that the key pair has a public key and a private key, but + the primary key is absent from the key pair. This suggests you won't be able + to perform certain specific operations (like adding subkeys, signing other + key pairs, etc.) + - `pub/sec^` implies that one or more keys (subkeys or master keys) from the + key pair are in the smart card. + - `pub/sec#^` denotes a simultaneous occurrence of the previous two + situations. + +- **Name**: Represents the identity information of the key pair. +- **Email Address**: Also denotes the identity information of the key pair. +- **Usage**: Determines which operations the key pair can execute. Composed of + four uppercase letters, each letter signifies a specific use. + + - `C` stands for Certificate. Key pairs containing the primary key generally + have this usage. + - `E` stands for Encrypt. The key pair can be used for encryption operations. + - `S` stands for Sign. The key pair can be used for signing operations. + - `A` stands for Authenticate. The key pair can be used to perform operations + like SSH authentication. + +- **Validity**: A Gpg concept that roughly represents the level 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 execute corresponding operations by clicking on the buttons +provided. For instance, after inputting text into a text editor and specifying +the desired key 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 require key specification, while others do not, as will be +detailed in the respective sections of this document. -### Customize +### Customization -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. +For operations that you may not use for a while, you have the option to uncheck +the associated function group in the top menu view. Conversely, for the +operations you frequently use, you have the ability to add them here. diff --git a/manual/manual/view-keypair-info.md b/manual/manual/view-keypair-info.md index 4fa407b9..88b501bb 100644 --- a/manual/manual/view-keypair-info.md +++ b/manual/manual/view-keypair-info.md @@ -1,113 +1,116 @@ # View Key Pair Details -Right-click the key pair in the key toolbox or key management interface and -click Show key details to view the information about the key pair. +You can view the details of a key pair by right-clicking on the key pair in the +key toolbox or key management interface and selecting "Show key details". -This part may involve a brief introduction to gpg-related concepts, and it will +This section may include a brief introduction to gpg-related concepts and could be relatively long. -The screenshot below is my friend's public key that I got from the key server. +Below is a screenshot of a friend's public key that I obtained 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). +And here is a randomly generated private key. The most significant difference +between this and the previous key is that the key pair with only the public key +is used for encryption only, but if you possess the private key, you can perform +more actions (it also depends on your algorithm; DSA can only be used for +signatures).  ## General Info -This interface provides some useful information to assist you in proper -management of the key pair. +This interface provides some useful information to help you manage your key pair +properly. ### Owner -Through this section, you can understand the owner of this key pair. This -information is not fixed and unchangeable. You can create a new UID in the UID -section and set it as the main UID to change it. +This section enables you to know the owner of this key pair. This information is +not fixed and can be changed. You can create a new UID in the UID section and +set it as the primary 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. If you want to learn more, see the [Basic -Concepts](../basic-concepts.md) section. +is very crucial because without it, you cannot perform related management +operations like adding and revoking sub-keys (similar to not being able to open +the key ring). 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. +not exist, but this doesn't mean that neither the public key nor the private key +exists. Please remember: Each subkey and primary key consist of a pair of public +and private keys.  #### Key ID -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. +This is the unique identifier of the key, which 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 +is shorter and more user-friendly. #### Algorithm -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. +This refers to the algorithm used for key generation. This also pertains 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. However, 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 ( This refers to the key generated using the RSA algorithm). +This is the length of the primary key. Generally, the longer the key, the harder +it is to crack the ciphertext. But at the same time, it takes more time 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 -What can the key pair conceptually be used for (including the conceptual usage -of the primary key and sub-key). When the primary key or subkey generation can -be used to sign, but it has already expired or does not exist, the signature -usage will still be displayed here. +This refers to what the key pair can conceptually be used for, including the +conceptual usage of the primary key and sub-key. When the primary key or subkey +generation can be used to sign, but it has already expired or does not exist, +the signature usage will still be displayed here. #### Actual Usage -The actual usage of the primary key and all subkeys. It is the union of their -usage. If there is only one primary key in the key pair that can be used for -signing, but this primary key does not exist. Then the signature usage will not -appear here, only in Normal Usage. In addition, when there is only one subkey -that can be used for signing, if it has expired, the signature purpose will not -be displayed here. +This is the actual usage of the primary key and all subkeys, which is the union +of their usage. If there is only one primary key in the key pair that can be +used for signing, but this primary key does not exist, then the signature usage +will not appear here, only in Normal Usage. In addition, when there is only one +subkey that can be used for signing, if it has expired, the signature purpose +will not be displayed here. #### Expires on -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 in the key pair. +This is the expiration time of the primary key. When the primary key expires, it +will become invalid and you can't 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 in the key +pair. #### Last Update -The time when the content of the key pair was last updated. Operations such as -adding a UID or subkey will modify the content of the key pair. +This is the time when the content of the key pair was last updated. Operations +such as adding a UID or subkey will modify the content of the key pair. #### Secret Key Existence -Shows whether the actual content of the primary key exists. When the primary key -does not exist, if there are still available subkeys in the key pair, the key -pair can still be used for normal operations. However, in the above case, the -content of the key pair cannot be modified (that is, operations such as adding -UID or subkey cannot be performed), and the key pair cannot sign other key -pairs. +This indicates whether the actual content of the primary key exists. When the +primary key does not exist, if there are still available subkeys in the key +pair, the key pair can still be used for normal operations. However, in the +above case, the content of the key pair cannot be modified (that is, operations +such as adding UID or subkey cannot be performed), and the key pair cannot sign +other key pairs. ### Fingerprint @@ -115,96 +118,78 @@ pairs. 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. +world. You can certainly do this with the key ID mentioned above. This also refers to the fingerprint of the primary key. ## UID Info -UID stands for User ID, and it is a mechanism used to identify a key, primarily -for the purpose of human identification. It can be compared to a name tag that -accompanies a key ring, indicating who the key ring belongs to. By looking at -the UID, humans can get a rough idea of whether a key pair is what they -expected, but for accurate identification, fingerprints or key IDs need to be -compared. A key can have one or more UIDs, while a key pair can have only one -primary UID. - -The primary UID is always listed first in the interface. +User ID (UID) is used to identify a key, mainly for human identification. It's +similar to a name tag that accompanies a key ring, indicating who the key ring +belongs to. By looking at the UID, users can get a rough idea of whether a key +pair is what they expected. However, for accurate identification, fingerprints +or key IDs should be compared. A key can have multiple UIDs, but a key pair can +only have one primary UID, which is always listed first in the interface.  -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. +UID has three elements: Name, Email, Comment. The name should be at least five +characters long, and the email should conform to the format. The rules for +comments are relatively loose. ### Signature of UID -The lower section of the interface displays the signature of the User ID (UID) -that was selected from the list of UIDs, not the one that was checked in the -box. - -This is a key trust system. When someone receives your public key, they obtain a -copy of your key ring with only your public key and nameplate. They can then use -their private key to sign your nameplate, indicating that they recognize your -brand and the public key on the entire key ring. Afterward, they can upload the -keyring with their signature to the keyserver. If many people follow suit, the -public key on the keyserver will have numerous signatures. The more signatures -on the nameplate, the more people recognize and endorse the public key, making -it trustworthy. +The lower section of the interface displays the signature of the selected User +ID (UID), not the checked one. This is a key trust system. When someone receives +your public key, they can use their private key to sign your nameplate, +indicating their recognition of your public key. Afterward, they can upload the +keyring with their signature to the keyserver. If many people do the same, the +public key on the keyserver will have numerous signatures, making it +trustworthy. -You can also use the primary key of another key pair to sign a UID. Generally, -when the primary UID of a key pair has many valid signatures, it is considered -more trustworthy than if it had none. +You can also use the primary key of another key pair to sign a UID. Generally, a +primary UID of a key pair with many valid signatures is considered more +trustworthy. ## Subkey Info The sub-key mechanism is a crucial feature of GPG that improves both flexibility -and security. However, it also introduces some complexity, which can make it -challenging for beginners to comprehend. If you are completely unfamiliar with -this concept, you may find it helpful to consult the below documentation. - -[Basic Concepts](../basic-concepts.md) - - - -To get a basic understanding of this concept, the following points can be -considered: +and security. However, it also introduces some complexity, which can be +challenging for beginners. For a basic understanding, consider the following +points: -- A key pair can be likened to a key ring, comprising of a primary key (a pair - of public and private keys) and multiple subkeys (or none). -- Each subkey and primary key comprises a pair of public and private keys. +- A key pair can be likened to a key ring, comprising a primary key (a pair of + public and private keys) and multiple subkeys (or none). +- Each subkey and primary key consists of a pair of public and private keys. - The subkey can perform related operations (such as signing, encryption) in the absence or unavailability of the primary key. - The functions of subkeys can overlap, and when both subkeys can be used for - signing, the one generated earlier is selected. + signing, the earlier one is selected. - Subkeys can use more algorithms than the primary key, but usually have the same effect on daily operations. - The disclosure of a subkey only affects that subkey, while the disclosure of the primary key endangers the entire key pair. The primary key and all subkeys in the key pair are displayed on the interface. -The first key in the list must be the main key, regardless of its existence. -Some information about the key is also listed below. In fact, it can be observed -that the information of the primary key here is the same as that of the first -tab. +Some information about the key is also listed below. ### 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. +Whether a key is in the smart card refers to whether the key is moved to the +smart card. Moving the key to the smart card changes 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. +In this column, what you can do differs for a key pair that only has a public +key and a key pair that includes a private key. -Here's what you can do with a public key-only key pair. +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. +And here's what you can do with a key pair that includes a private key:  -These operations will be scattered in the documentation to explain in detail. +These operations will be explained in detail throughout the documentation.
\ No newline at end of file diff --git a/manual/quick-start.md b/manual/quick-start.md index 91d188c6..8e864a24 100644 --- a/manual/quick-start.md +++ b/manual/quick-start.md @@ -1,132 +1,128 @@ # Getting Started -One of the unique features of GpgFrontend is its cross-platform capability. -Depending on your operating system, the installation process might vary. +GpgFrontend is a versatile tool featuring cross-platform compatibility. The +installation process may vary depending on your operating system. ## Prerequisites -**If you are a Windows or macOS user with Homebrew, you can skip this section.** +**For Windows or macOS users with Homebrew, this section can be skipped.** -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. +As GpgFrontend is built on the basic functions provided by GnuPG, you need to +install GnuPG before running GpgFrontend. From GnuPG 2.0 onward, GPG works on +separate modules for each of its functionalities, and these modules need to be +correctly integrated into your operating system for smooth operation. -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. +Please note, GnuPG cannot operate within an App Sandbox, so GpgFrontend is +currently not available on the Apple Store. -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.** +Most recent Linux distributions come with a pre-installed GnuPG 2.0 environment. +You can verify this by typing `gpg --version` in the command line. **However, it +is recommended to install GnuPG versions 2.2 or higher.** ## Install & Run Steps ### Windows (No Setup) -1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest) - `GpgFrontend-*******-windows-x86_64-portable.zip` -2. Unzip it. (Necessary) -3. Go into the `Program/bin` directory and double click `GpgFrontend.exe`. +1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest) the + file `GpgFrontend-*******-windows-x86_64-portable.zip`. +2. Unzip the downloaded file. (This step is necessary) +3. Navigate to the `Program/bin` directory and double-click `GpgFrontend.exe`. -### Windows（Setup） +### Windows (Setup) -1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest) - `GpgFrontend-*******-windows-x86_64-setup.exe` -2. Install it, and you can find GpgFrontend on your desktop. +1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest) the + file `GpgFrontend-*******-windows-x86_64-setup.exe`. +2. Follow the installation process, and GpgFrontend will be accessible from your + desktop. ### macOS -All published app packages have passed Apple's check, which means you can open it directly without -extra permission. +All published app packages have passed Apple's verification checks, meaning you +can open it directly without requiring extra permissions. #### Homebrew Cask -You can use Homebrew Cask to quickly and easily install or remove GpgFrontend in your machine. +Use Homebrew Cask to install or remove GpgFrontend from your machine quickly and +easily. -0. Check if Homebrew is installed in your machine. -1. Install GpgFrontend by running command `brew install --cask gpgfrontend` -2. Find GpgFrontend in Launchpad, double-click and run it. +0. Ensure Homebrew is installed on your machine. +1. Install GpgFrontend by running the command `brew install --cask gpgfrontend`. +2. Find GpgFrontend in your Launchpad, double-click, and run it. #### Download and Install from DMG -0. Install `gnupg` using Homebrew OR download "GPG for OS X" +0. Install `gnupg` using Homebrew OR download "GPG for OS X" from [Here](https://sourceforge.net/projects/gpgosx/files). 1. [Download](https://github.com/saturneric/GpgFrontend/releases) - `GpgFrontend-*******-macos-**.dmg` - - `x86_64` just means it build in such an x86 machine. Actually, it can run - smoothly on both Intel and Apple(M1/M2) Chips. -2. Double-Click GpgFrontend.dmg to load it. -3. Double-Click and run it. -4. If it satisfies you, you can drag it into your Application folder. + `GpgFrontend-*******-macos-**.dmg`. + - `x86_64` indicates the build machine type. This version will run smoothly + on both Intel and Apple(M1/M2) Chips. +2. Double-click GpgFrontend.dmg to load it. +3. Double-click to run it. +4. If you're satisfied with the program, 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. - -0. Install gnupg (If you have already followed please skip) - - For Debian/Ubuntu +without needing superuser privileges to install them. It packages the +application and all files needed for the application to run in a single file, +thus avoiding dependency issues. This makes the distribution of software more +user-friendly. + +0. Install gnupg (Skip if you have already done this) + - For Debian/Ubuntu: ```shell $ sudo apt update $ sudo apt install gpg ``` - - For CentOS + - For CentOS: ```shell $ sudo yum install gnupg ``` -1. [Download](https://github.com/saturneric/GpgFrontend/releases) `GpgFrontend-*******-linux-x86_64.AppImage` -2. Give it permission to execute +1. [Download](https://github.com/saturneric/GpgFrontend/releases) the file + `GpgFrontend-*******-linux-x86_64.AppImage`. +2. Grant execute permissions to the file: ```shell $ chmod u+x ./GpgFrontend-***-linux-x86_64.AppImage ``` -3. Just double-click it to run it. +3. Double-click the file to run it. ## BSD(FreeBSD/OpenBSD) -For BSD users, unfortunately, the binary release is not provided yet. But you -can build and run GpgFrontend in these operating systems. +If you're a BSD user, note that binary releases aren't provided yet. However, +you can still build and run GpgFrontend on these operating systems. ## Get from GitHub Release -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 primary distribution channel is the Release feature available on GitHub. +This method is free and accessible to most people globally, eliminating the need +for me to manage servers and bandwidth, thus saving resources. -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. +Upon clicking the +[download](https://github.com/saturneric/GpgFrontend/releases/latest) link, you +will see an interface displaying the current version number of the latest +release, its release date, and more.  -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 -GpgFrontend for different operating systems. As you can see, the parts of the -file name are separated by separators. +In the main text, you can find some significant features or fixes for the +version. If you're a programmer, you can also view the change log to see how the +source code differs from the previous version. Notice the two green tick marks, +which represent that I have personally signed the source code for the version. +This can be crucial for users with high-security needs. -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. +Scrolling down, you can find several Assets. These are releases of GpgFrontend +for different operating systems. The parts of the filename are separated by +separators. The second section (e.g., 6171479) is a unique identification number +for the version's source code. When pointing out problems with a version, +remember to provide this 7-digit unique identification number.  -Files with signature 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 'signature' as the suffix are GPG separate signatures for the +corresponding released version of the file. You can use GPG to verify whether +the downloaded 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. +Choose the appropriate release version according to your needs or the +instructions provided, and click on the name to download.
\ No newline at end of file |