aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSaturneric <[email protected]>2022-01-05 08:00:55 +0000
committerSaturneric <[email protected]>2022-01-05 08:00:55 +0000
commit91b078ed55171ea5f9c8e27ad60ecf3a27df78d6 (patch)
treee2370d6eca2f51a0b8345e50cc414b9129b6f892
parent<fixed>(ui/aes): fixed security problem. (diff)
parentMerge branch 'main' into develop (diff)
downloadGpgFrontend-91b078ed55171ea5f9c8e27ad60ecf3a27df78d6.tar.gz
GpgFrontend-91b078ed55171ea5f9c8e27ad60ecf3a27df78d6.zip
<docs>(document): sync the document.
-rw-r--r--PrivacyPolicy.md47
-rw-r--r--README.md116
-rw-r--r--SECURITY.md19
3 files changed, 86 insertions, 96 deletions
diff --git a/PrivacyPolicy.md b/PrivacyPolicy.md
new file mode 100644
index 00000000..4d8c28c1
--- /dev/null
+++ b/PrivacyPolicy.md
@@ -0,0 +1,47 @@
+# Privacy Policy of GpgFrontend
+
+This application respects and protects the personal privacy of all service users. In order to provide you with more
+accurate and personalized services, this application will use and disclose your personal information in accordance with
+the provisions of this privacy policy. However, this application will treat this information with a high degree of
+diligence and prudence. Except as otherwise provided in this privacy policy, this application will not disclose or
+provide this information to third parties without your prior permission. This application will update this privacy
+policy from time to time.
+
+When you agree to this application service use agreement, you are deemed to have agreed to the entire content of this
+privacy policy. This privacy policy is an integral part of this application service usage agreement.
+
+## Scope of application
+
+1. When you use this application to upload your public key to your designated key server, the information on your
+ computer automatically received by this application includes only the public key content of your key pair.
+
+## Use of Information
+
+1. This application will not store information outside the scope of application in any form on any server.
+2. This application will not provide your information to any unrelated third-party key server that has not been
+ designated by you.
+3. This application also does not allow any third party to collect, edit, sell or disseminate your information for free
+ by any means. If any user of this application platform engages in the above activities, once discovered, this
+ application has the right to terminate the prosecution of the user and prohibit the user from using this application.
+
+## Information Disclosure
+
+In the following cases, this application will partially disclose your personal information based on your personal
+wishes:
+
+1. With your prior consent, disclose the public key information of your designated key to a third-party key server;
+
+## Information storage and exchange
+
+1. The information collected by this application about the public key specified by you will be stored on the key server
+ specified by you. Such information and materials may be sent to your country or region or outside the country/region
+ where the information and materials are collected by this application, and be accessed and stored outside that
+ country/region. And show.
+
+## Changes to this privacy policy
+
+1. If you decide to change the privacy policy, I will post these changes in this policy, on the website, and where we
+ deem appropriate, so that you can understand how we collect and use your personal information, who can access this
+ information, and where Under what circumstances will we disclose this information.
+2. I reserve the right to modify this policy at any time, so please check it frequently. If there is a major change to
+ this policy, the company will notify it through a website notice.
diff --git a/README.md b/README.md
index cc855d60..0ea3982d 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,10 @@
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d1750e052a85430a8f1f84e58a0fceda)](https://www.codacy.com/gh/saturneric/GpgFrontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saturneric/GpgFrontend&utm_campaign=Badge_Grade)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/saturneric/gpgfrontend)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaturneric%2FGpgFrontend?ref=badge_small)
+[![Build & Package](https://github.com/saturneric/GpgFrontend/actions/workflows/release.yml/badge.svg?branch=main)](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/)
-Crypto Tool.
+Crypt 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.
@@ -18,12 +19,12 @@ Please **take the initiative to protect privacy in your own hands**, instead of
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.
-GpgFrontned [supports languages](#languages-support) that are widely used in most countries and regions around the
+GpgFrontend [supports languages](#languages-support) 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 backdoor during the delivery process.**
+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!
@@ -33,23 +34,13 @@ If you find this tool useful and promising, welcome to encourage me through STAR
<div align="center">
<img src="https://github.com/saturneric/Blob/blob/master/screenshots/main-ubuntu.png?raw=true" alt="Ubuntu Main Screenshot"/>
</div>
-
-#### Workflows Status:
-
-[![Build & Package](https://github.com/saturneric/GpgFrontend/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/saturneric/GpgFrontend/actions/workflows/release.yml)
-
---
## Table of Contents
- [Usage](#usage)
- [Quick Start](#quick-start)
- - [How to Run it](#how-to-run-it)
- - [Windows](#windows)
- - [macOS](#macos)
- - [Debian/Ubuntu/CentOS](#debianubuntucentos)
- [Document](#document)
-- [Purpose](#purpose)
- [Build](#build)
- [Languages Support](#languages-support)
- [Contributing & Bugs Report](#contributing--bugs-report)
@@ -61,104 +52,38 @@ If you find this tool useful and promising, welcome to encourage me through STAR
### Quick Start
-### Fast Text Encryption
+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
Encryption can be done in just a few clicks.
![GIF](https://github.com/saturneric/Blob/blob/master/gif/encrypt-sign.gif?raw=true)
-### Fast Text Decryption
+#### Fast Text Decryption
I want to see what you wrote right away.
![GIF](https://github.com/saturneric/Blob/blob/master/gif/decrypt-verify.gif?raw=true)
-### Fast File Encryption & Sign
+#### Fast File Encryption & Sign
What about files?
![GIF](https://github.com/saturneric/Blob/blob/master/gif/encr-sign-file.gif?raw=true)
-### More Helpful Operation
-
-Read the animated pictures in the [Document](https://gpgfrontend.pub/#/quick-start) to learn more awesome operations.
-
-### How to Run it
-
-#### Windows (No Setup)
-
-0. If you haven't installed gnupg,
- please [Download](https://gnupg.org/ftp/gcrypt/binary/gnupg-w32-2.3.1_20210420.exe) `gnupg-w32-******.exe` and
- install it.
-1. [Download GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Windows Edition from the latest release
-2. Unzip `gpgfrontend-windows-latest-*******.zip`
-3. Go into the directory and double click `GpgFrontend.exe`.
-
-#### Windows (Setup)
-
-0. Double click `GpgFrontend-...-Setup.exe`.
-1. Use GpgFrontend.
-
-#### macOS
-
-0. If command `gpg` is not available, please use homebrew to install it first.
- ```shell
- $ sudo brew install gpg
- ```
-1. [Download GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) macOS edition from the latest release
-2. Double-Click GpgFrontend.dmg to load it
-3. Double click and run it
- - Every Release App is Now Code-Signed By Develop ID Certificate and Checked By Apple Inc.
-4. If it satisfies you, you can drag it into your Application folder.
-
-#### Debian/Ubuntu/CentOS
-
-[![!AppImage](https://docs.appimage.org/_images/download-appimage-banner.svg)](https://github.com/saturneric/GpgFrontend/releases/latest)
-
-0. Install gnupg (If you have already followed please skip)
- - For Debian/Ubuntu
- ```shell
- $ sudo apt update
- $ sudo apt install gpg
- ```
- - For CentOS
- ```shell
- $ sudo yum install gnupg
- ```
-1. [Download GpgFrontend](https://github.com/saturneric/GpgFrontend/releases) Linux edition from the latest release
-2. Give `GpgFrontend-***.AppImage` permission to execute
- ```shell
- $ chmod u+x ./GpgFrontend-***.AppImage
- ```
-3. Just double-click `GpgFrontend-***.AppImage` to run it. (If you installed AppImage Launcher, it's better.)
-
## Document
-For more usage information, please read [document](https://gpgfrontend.pub/#/overview).
-
-## Purpose
-
-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.
-
-GpgFrontend will add more functions in the future to improve the ease of use of GPG in end-to-end transmission. 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.
-
-The GpgFrontend project is as open source, and it also insists on using open source codes and libraries.
+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
-The tutorial for building the software will be released shortly. Before the relevant documents are released, you can
-refer to the project-related Github Action file if you know it.
+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.
## 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 [translate the interface](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
+the [here](https://gpgfrontend.pub/#/translate-interface).
### Supported Languages
@@ -171,13 +96,13 @@ Notice: The verification may not be complete and rigorous.
## Contract
-If you want to contact me individually, you can email [[email protected]](mailto:[email protected]).
+Please refer to [here](https://www.gpgfrontend.pub/#/contract) for my contact details.
### Contributing & Bugs Report
Feel free to dive in! [Open an issue](https://github.com/saturneric/GpgFrontend/issues/new) or submit PRs.
-### Maintainers
+### Project Maintainer
[@Saturneric](https://github.com/saturneric).
@@ -193,8 +118,7 @@ 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
@@ -202,7 +126,9 @@ gpgme: https://gnupg.org/software/gpgme/index.html
gpg4usb: https://www.gpg4usb.org
-QT 5.15.2(opensource): https://www.qt.io
+QT 5.15(opensource): https://www.qt.io
+
+QT 5.12(opensource): https://www.qt.io
MSYS2: https://www.msys2.org
@@ -215,6 +141,4 @@ JSON for Modern C++: https://github.com/nlohmann/json
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
new file mode 100644
index 00000000..24c74fb0
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,19 @@
+# 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.