lysann/passforios-gopenpgp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation fixes (#43)

Browse source 
* Fix Comment - NewKeyFromReader

* Trailing whitespace, correct function name

* Update CHANGELOG

* update README

Co-authored-by: zugzwang <talbotvinnik@pm.me>
Co-authored-by: Aron Wussler <aron@wussler.it>
This commit is contained in:
zugzwang 2020-04-25 16:28:07 +02:00 • committed by GitHub
parent 486e1220a1
commit 0f35072bc4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -5,8 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased] ## [Unreleased]
### Security
- Updated underlying crypto library
### Fixed ### Fixed
- Fixed test `TestMultipleKeyMessageEncryption` - Fixed test `TestMultipleKeyMessageEncryption`
- Fixed garbage collection issues when compiled on gomobile, by copying byte slices
### Added ### Added
- SHA256 fingerprint support - SHA256 fingerprint support

5
README.md
View file

@ -1,4 +1,5 @@
# GopenPGP V2 # GopenPGP V2
[![Build Status](https://travis-ci.org/ProtonMail/gopenpgp.svg?branch=master)](https://travis-ci.org/ProtonMail/gopenpgp)
GopenPGP is a high-level OpenPGP library built on top of [a fork of the golang GopenPGP is a high-level OpenPGP library built on top of [a fork of the golang
crypto library](https://github.com/ProtonMail/crypto). crypto library](https://github.com/ProtonMail/crypto).
@ -360,8 +361,8 @@ pgpMessage := pgpSplitMessage.GetPGPMessage()
// And vice-versa // And vice-versa
newPGPSplitMessage, err := pgpMessage.SeparateKeyAndData() newPGPSplitMessage, err := pgpMessage.SeparateKeyAndData()
// Key Packet is in newPGPSplitMessage.GetKeyPacket() // Key Packet is in newPGPSplitMessage.GetBinaryKeyPacket()
// Data Packet is in newPGPSplitMessage.GetDataPacket() // Data Packet is in newPGPSplitMessage.GetBinaryDataPacket()
``` ```
### Checking keys ### Checking keys

2
crypto/key.go
View file

@ -39,7 +39,7 @@ func NewKeyFromArmoredReader(r io.Reader) (key *Key, err error) {
return key, nil return key, nil
} }
// NewKeyFromReader reads an binary data into Key // NewKeyFromReader reads binary data into a Key object.
func NewKeyFromReader(r io.Reader) (key *Key, err error) { func NewKeyFromReader(r io.Reader) (key *Key, err error) {
key = &Key{} key = &Key{}
err = key.readFrom(r, false) err = key.readFrom(r, false)