diff options
Diffstat (limited to 'src/content/docs/guides/sign-verify-file.md')
-rw-r--r-- | src/content/docs/guides/sign-verify-file.md | 132 |
1 files changed, 96 insertions, 36 deletions
diff --git a/src/content/docs/guides/sign-verify-file.md b/src/content/docs/guides/sign-verify-file.md index c25ddd6..7693bf4 100644 --- a/src/content/docs/guides/sign-verify-file.md +++ b/src/content/docs/guides/sign-verify-file.md @@ -49,55 +49,115 @@ a user-friendly manner. By accommodating binary file operations, it ensures that digital signatures are accessible and applicable across a broad spectrum of file types, reinforcing the pillars of trust and security in digital communications. -## Introduction to File Extensions +## Sign & Verify File -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. +GpgFrontend extends its utility from handling text-based operations to +facilitating file operations with ease and security. The principle behind +signing and verifying files mirrors that of text, leveraging the robust +framework of digital signatures. However, a significant distinction lies in the +nature of the input and output for file operations, which can be binary, +accommodating a wider range of file types beyond simple text documents. + +## Using File Browser for Signing and Verifying + +After clicking the **File Browser** button, a system directory selection dialog +will appear. Follow these steps to perform signing and verifying operations: + +1. **Open File Browser**: + + - Click the **File Browser** button in the toolbar at the top of the + interface. This will open a system dialog allowing you to choose a + directory. + +2. **Select Directory**: + + - In the system dialog, navigate to the desired directory and select it. Once + selected, a new tab named "File Browser" will open in GpgFrontend, + displaying the contents of the chosen directory. + +3. **Select a File**: + + - In the File Browser tab, you will see a list of files and folders within + the selected directory. Click on the file you want to sign or verify. + +4. **Sign the File**: + + - To sign a file, first select the file in the File Browser. Then, in the + **Key Toolbox** on the right, select your private key by checking the box + next to your key. Finally, click the **Sign** button in the toolbar at the + top. + +5. **Verify the File**: + + - To verify a file, select the signed file in the File Browser. Ensure you + have the corresponding public key in your keyring. Click the **Verify** + button in the toolbar. If the correct key is available, the file's + signature will be verified. + + + +By following these steps, you can easily manage file signing and verifying using +the GpgFrontend's File Browser feature. This streamlined process allows you to +handle your cryptographic needs directly from the file system interface. + +## File Extension Requirements + +GpgFrontend supports different file extensions for various cryptographic +operations. Understanding these extensions helps in properly managing signed +files. Here’s a breakdown of the file extensions used: + +#### ASCII Format + +- **.asc**: Files with the ".asc" extension are in ASCII format. These files + contain ASCII-armored signatures, which are a text representation of the + signed data. ASCII format is typically used for easy sharing via email or text + editors, as it ensures compatibility with text-based applications. -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. +#### Binary Format - +- **.sig**: Files with the ".sig" extension are in binary format. Binary + signature files are more compact than their ASCII counterparts and are + generally used for more efficient storage and transmission. They cannot be + viewed directly in text editors, as the content is in a binary format. +- **.gpg**: Files with the ".gpg" extension are also used for binary signatures. + These files are used when both encryption and signing are performed together, + containing both the encrypted content and the signature. -## File Browser +To perform verification operations, you need to use files with either the +".sig", ".gpg", or ".asc" extension. These files contain the necessary signature +content required for these operations. -You can open the file browser (Ctrl/Command + B) via the top menu file option. -After selecting a target directory at system navigator, you can get a new File -browser tab. 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. +By adhering to these file extension requirements, you can ensure that your +signed files are correctly recognized and processed by GpgFrontend. - +### Default Output Mode -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. +Before version 2.0.4, GpgFrontend generated signature files exclusively in ASCII +format. However, beginning with version 2.0.4, GpgFrontend now generates +signature files in binary format by default. This setting can be adjusted in the +program's settings. -On the far right is a button offering useful options, such as displaying system -files or hidden files. +### Changing Output Mode - +To change the output mode between ASCII and binary formats, follow these steps: -### Sign +1. **Open Settings**: -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. + - Navigate to the GnuPG Controller settings within GpgFrontend. This can be + done by accessing the settings menu from the main interface. - +2. **Locate Binary Mode Option**: -### Verify + - In the settings interface, under the "General" section, locate the option + labeled "Use Binary Mode for File Operations". -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. +3. **Toggle Binary Mode**: + - Check or uncheck this option to switch between binary (sig/gpg) and ASCII + (asc) output formats. Checking the box will enable binary mode, while + unchecking it will revert to ASCII format. -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. +By following these steps, you can customize how GpgFrontend handles the format +of signature files according to your preference or needs. - + |