mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-10-31 17:45:58 +01:00
17 KiB
17 KiB
PGPainless Changelog
1.1.5-SNAPSHOT
- SOP encrypt: match signature type when using
encrypt --as=
option ProducerOptions.setEncoding()
: The encoding is henceforth only considered metadata and will no longer trigger CRLF encoding.- This fixes broken signature generation for mismatching (
StreamEncoding
,DocumentSignatureType
) tuples. - Applications that rely on CRLF-encoding can request PGPainless to apply this encoding by calling
ProducerOptions.applyCRLFEncoding(true)
.
- This fixes broken signature generation for mismatching (
1.1.4
- Add utility method
KeyRingUtils.removeSecretKey()
to remove secret key part from key ring- This can come in handy when using primary keys stored offline
- Add
EncryptionResult.isEncryptedFor(certificate)
ArmorUtils.toAsciiArmoredString()
methods now print out primary user-id and brief information about further user-ids (thanks @bratkartoffel for the patch)- Methods of
KeyRingUtils
andArmorUtils
classes are now annotated with@Nonnull/@Nullable
- Enums
fromId(code)
methods are now annotated with@Nullable
and there are nowrequireFromId(code)
counterparts which are@Nonnull
. ProducerOptions.setForYourEyesOnly()
is now deprecated (reason is deprecation in the- crypto-refresh-05 document)
- Add
SessionKey.toString()
- Partially fix generation of malformed signature packets when using different combinations of
StreamEncoding
andDocumentSignatureType
values- Unfortunately PGPainless still produces broken signatures when using either
StreamEncoding.TEXT
orStreamEncoding.UTF8
in combination withDocumentSignatureType.BINARY_DOCUMENT
.
- Unfortunately PGPainless still produces broken signatures when using either
- Deprecate
ProducerOptions.setEncoding(StreamEncoding)
- Will be removed in a future release
- Remove
StreamEncoding.MIME
(was removed from the standard)
1.1.3
- Make
SigningOptions.getSigningMethods()
part of internal API - Fix crash when trying to do verification of unmatched
SignersUserId
signature subpacket- For now, verification of
SignersUserId
is disabled but can be enabled viaPolicy.setSignerUserIdValidationLevel()
- For now, verification of
- Initial support for
OpenPgpV5Fingerprint
- Add
OpenPgpFingerprint.parse(string)
- Security: Fix
KeyRingInfo.getValidAndExpiredUserIds()
accidentally including unbound user-ids
1.0.5
- Security: Fix
KeyRingInfo.getValidAndExpiredUserIds()
accidentally including unbound user-ids
1.1.2
- Fix
keyRingInfo.getEmailAddresses()
incorrectly matching some mail addresses (thanks @bratkartoffel for reporting and initial patch proposal) - Fix generic type of
CertificationSubpackets.Callback
- Add
KeyRingInfo.isUsableForEncryption()
- Add
PGPainless.inspectKeyRing(key, date)
- Allow custom key creation dates during key generation
- Reject subkeys with bindings that predate key generation
EncryptionOptions.addRecipient()
: TransformNoSuchElementException
intoIllegalArgumentException
with proper error message- Fix
ClassCastException
by preventing accidental verification of 3rd-party-issued user-id revocation with primary key. - Fix
NullPointerException
when trying to verify malformed signature
1.1.1
- Add
producerOptions.setComment(string)
to allow adding ASCII armor comments when creating OpenPGP messages (thanks @ferenc-hechler) - Simplify consumption of cleartext-signed data
- Change default criticality of signature subpackets
- Issuer Fingerprint: critical -> non-critical
- Revocable: non-critical -> critical
- Issuer KeyID: critical -> non-critical
- Preferred Algorithms: critical -> non-critical
- Revocation Reason: critical -> non-critical
1.1.0
pgpainless-sop
: Updatesop-java
to version 1.2.0- Treat passwords and session keys as indirect parameters This means they are no longer treated as string input, but pointers to files or env variables
1.0.4
- Yet another patch for faulty ASCII armor detection 😒
1.0.3
- Fix detection of unarmored data in signature verification
1.0.2
- Update SOP implementation to specification revision 03
- Move
sop-java
andsop-java-picocli
modules to its own repository OpenPGPV4Fingerprint
: Hex decode bytes in constructor- Add
ArmorUtils.toAsciiArmoredString()
for single key - Fix
ClassCastException
when retrievingRevocationKey
subpackets from signatures - Fix
pgpainless-sop
gradle script- it now automatically pulls in transitive dependencies
1.0.1
- Fix sourcing of preferred algorithms by primary user-id when key is located via key-id
1.0.0
- Introduce
DateUtil.toSecondsPrecision()
- Clean JUnit tests, fix code style issues and fix typos in documentation
1.0.0-rc9
- When key has both direct-key sig + primary user-id sig: resolve expiration date to the earliest expiration
- Add
SecretKeyRingEditor.removeUserId()
convenience methods that do soft-revoke the user-id. - Add
SelectUserId.byEmail()
which also matches the plain email address
1.0.0-rc8
KeyRingInfo.getPrimaryUserId()
: return first user-id when no primary user-id is found- Rename method
getBoundButPossiblyExpiredUserIds
togetValidAndExpiredUserIds()
- Remove audit resource material
1.0.0-rc7
- Make
Passphrase
comparison constant time - Bump Bouncycastle to 1.70
- Use new
PGPCanonicalizedDataGenerator
where applicable - Implement decryption with user-provided session key
- Remove workaround for invalid signature processing
- Use new
- Remove Blowfish from default symmetric decryption/encryption policy
- When adding/generating keys: Check compliance to
PublicKeyAlgorithmPolicy
- Fix
BaseSecretKeyRingProtector
misinterpreting empty passphrases - SOP: Fix NPE when attempting to sign with key with missing signing subkey
- Describe Threat Model in [pgpainless-core/README.md]
- Fix NPE when attempting to decrypt GNU_DUMMY_S2K key
- Validate public key parameters when unlocking secret keys
- Introduce iteration limits to prevent resource exhaustion when
- reading signatures
- reading keys
CachingSecretKeyRingProtector
: Prevent accidental passphrase overriding viaaddPassphrase()
EncryptionOptions
: replace method argument typePGPPublicKeyRingCollection
withIterable<PGPPublicKeyRing>
to allow forCollection<PGPPublicKeyRing>
as argumentSigningOptions
: replace method argument typePGPSecretKeyRingCollection
withIterable<PGPSecretKeyRing>
to allow forCollection<PGPSecretKeyRing>
as argument- Prevent message decryption with non-encryption subkey
- Rework key modification API to fix inconsistency problems with expiration and primary user-ids.
- Remove methods to change expiration dates of subkeys and specific user-ids
- Rework primary user-id marking logic to unmark non-primary ids
- Added Cure53 Security Audit Report to the website
- Reworked tests for cryptographic backend to use custom
InvocationContextProvider
implementation - Source
PGPObjectFactory
objects fromImplementationProvider
- Fix typo
getCommendHeader() -> getCommentHeader()
1.0.0-rc6
- Restructure method arguments in
SecretKeyRingEditor
- Add explanations of revocation reasons to
RevocationAttributes
- Rename
CertificationSignatureBuilder
toThirdPartyCertificationSignatureBuilder
KeyAccessor.ViaKeyId
: Differentiate between primary key (rely on direct-key sig) and subkey (subkey binding sig)- Expose
SignatureSubpacketsUtil.getKeyLifetimeInSeconds
- Various cleanup steps and new tests
1.0.0-rc5
- Fix invalid cursor mark in
BufferedInputStream
when processing large cleartext signed messages - Add
SecretKeyRingEditor.revokeUserIds(SelectUserId, SecretKeyRingProtector, RevocationSignatureSubpackets.Callback)
1.0.0-rc4
- Fix bug where
KeyRingBuilder
would mark additional user-ids as primary
1.0.0-rc3
- New Signature builder API for more fine-grained control over key-signatures:
- Introduce
CertificationSignatureSubpackets
builder class to wrapPGPSignatureSubpacketGenerator
for certification style signatures. - Introduce
SelfSignatureSubpackets
builder class for self-signatures. - Introduce
RevocationSignatureSubpackets
builder class for revocation signatures. - Introduce
CertificationSignatureSubpackets.Callback
,SelfSignatureSubpackets.Callback
andRevocationSignatureSubpackets.Callback
to allow modification of signature subpackets by the user. - Incorporate
*SignatureSubpackets.Callback
classes as arguments inSecretKeyRingEditor
andKeyRingBuilder
methods.
- Introduce
- Start working on
ProofUtil
to create KeyOxide style identity proofs (WIP) - Move Signature verification related code to
org.pgpainless.signature.consumer
package - Ensure keyflags and other common subpackets are set in new signatures when adding user-ids
- Ensure subkey can carry keyflag when adding it to a key
- Refactor
SecretKeyRingProtector
methods and code
1.0.0-rc2
SecretKeyRingEditor
: Remove support for user-id- and subkey deletion in favor of revocation- Deletion causes all sorts of problems. Most notably, receiving implementations will not honor deletion of user-ids/subkeys.
If you really need to delete user-ids there now is
KeyRingUtils.deleteUserId(keys, userid)
, but its use is highly discouraged and should only (if ever) be used for local manipulations of keys.
- Deletion causes all sorts of problems. Most notably, receiving implementations will not honor deletion of user-ids/subkeys.
If you really need to delete user-ids there now is
pgpainless-core
&pgpainless-sop
: Fix accidental compile scope dependency onlogback-classic
KeyRingInfo
: Sensible arguments for methods to get preferred algorithms
1.0.0-rc1
- First release candidate for a 1.0.0 release! \o/
- Rename
EncryptionPurpose.STORAGE_AND_COMMUNICATIONS
toEncryptionPurpose.ANY
- Hide
PGPainless.verifyCleartextSignedMessage()
behindPGPainless.decryptAndVerify()
.- the latter now checks whether the message is cleartext-signed or not and automatically calls the proper API
MultiPassStrategy
objects are now set throughConsumerOptions.setMultiPassStrategy()
.
- Separate key ring generation through templates from custom key ring builder
PGPainless.generateKeyRing()
now offers to generate keys from templatesPGPainless.buildKeyRing()
offers a detailed API to build custom keys
- Fix detection of non-armored data
0.2.19
- Some preparations for OpenPGP V5 keys:
OpenPgpV4Fingerprint
is now an implementation ofOpenPgpFingerprint
SignatureVerification
andFailure
now havetoString()
implementations- Logging:
logback-classic
is now an optional runtime dependency
0.2.18
- Fix compatibility with PGPainless < 0.2.10
- Fix interoperability with Kleopatra
- Decryption: Do not skip over first PKESKs when we have a matching decryption key
- MessageInspector: Break from object factory loop after encountering encrypted data (we cannot go deeper)
- Move hash algorithm negotiation to own class
- Change return value of
EncryptionOptions.overrideEncryptionAlgorithm()
0.2.17
- Fix prematurely throwing
MissingPassphraseException
when decrypting message with multiple possible keys and passphrases
0.2.16
- Fix handling of subkey revocation signatures
- SOP: improve API usage with byte arrays
- Fix
AssertionError
when determining encryption subkeys from set containing unbound key - Add
ConsumerOptions.setMissingKeyPassphraseStrategy(strategy)
to modify behavior when missing key passphrases are encountered during decryption
0.2.15
- Add
ConsumerOptions.setIgnoreMDCErrors()
which can be used to consume broken messages. Not recommended! - Add
MessageInspector.isSignedOnly()
which can be used to identify messages created viagpg --sign --armor
- Workaround for BCs
PGPUtil.getDecoderStream
mistaking plaintext for base64 encoded data - Cleanup of unused internal methods
- SOP: Fix
ArmorImpl
writing data to provided output stream instead ofSystem.out
- Fix hen and egg problem with streams in signature detaching implementation of SOP
- Make code REUSE compliant
0.2.14
- Export dependency on Bouncycastle's
bcprov-jdk15on
- Rework Key Generation API
- Replace builder-chain structure with single
KeyRingBuilder
class
- Replace builder-chain structure with single
- Change return value of
CleartextSignatureProcessor.process()
toDecryptionStream
- Rename
CleartextSignatureProcessor.process()
toCleartextSignatureProcessor.getVerificationStream()
- Add support for creating cleartext signed messages by calling
ProducerOptions.setCleartextSigned()
- Add examples for signing messages in the
examples
package.
0.2.13
- Add
MessageInspector
class to determine IDs of recipient keys. - PGPainless now tries decryption using keys with available passphrases first and only then request key passphrases using callbacks.
0.2.12
- Fix: Add workaround for BC defaulting to S2K
USAGE_CHECKSUM
by changing S2K usage toUSAGE_SHA1
- Repair keys with
USAGE_CHECKSUM
when changing passphrase
0.2.11
- Fix: When changing expiration date of keys, also consider generic and casual certifications
0.2.10
- Cleartext Signature Framework
- Reuse
ConsumerOptions
class for verification - Return
OpenPgpMetadata
object as result of verification
- Reuse
- Change default compression algorithm from
UNCOMPRESSED
toZIP
- Cleanup: Move Signature Verification code to dedicated internal stream
0.2.9
- Allow customization of ASCII armor comment and version headers
- Small bug fixes of SOP implementation
- Readability fixes
- Switch from JUL to slf4j for logging
- SOP: Native support for verify-not-before and verify-not-after
- SOP: Adopt changes for SOP spec version 2
- Add
detach-inband-signatures-and-message
subcommand - Add support for environment variables
- Remove
-allow-nested
- Add
- Cleartext Signature Framework: Fix handling of trailing newlines
0.2.8
- Encrypt to all capable subkeys by default
- Ignore missing CRC checksums in ASCII Armor
0.2.7
- Fix writing data to standard out in the
java-sop-picocli
module - Improve handling of signatures with missing issuer-key-id packets
- Properly ignore marker packets
- Add issuer-fingerprint packets to message signatures by default
- Fix ordering (bracketing) and nested-ness of one-pass-signatures
- Fix interoperability issue with Thunderbird
- Some keys caused wrong partial-length encodings for integrity protected session packets
0.2.6
- Actually properly detect CRC checksum errors in ASCII armor
0.2.5
- Explicitly reject non-self-signatures when picking user-id self-signatures
- pgpainless-cli: Set executable name in help text
- Properly detect CRC checksum errors in ASCII armor
0.2.4
- Java based Stateless OpenPGP Protocol
- Introduce
sop-java
module
Contains Java interfaces modelling the Stateless OpenPGP Protocol - Introduce
sop-java-picocli
Command Line Interface frontend forsop-java
based OpenPGP implementations pgpainless-sop
now contains an implementation ofsop-java
usingpgpainless-core
pgpainless-cli
now contains a ready to use OpenPGP command line application
It simply plugspgpainless-sop
intosop-java-picocli
.
- Introduce
- Remove deprecated encryption API
- Remove deprecated decryption API
- Add
PGPainless.extractCertificate()
andPGPainless.asciiArmor()
methods OpenPgpMetadata
:getDecryptionKey()
andgetVerifiedSignatures()
now returnSubkeyIdentifier
objectsKeyRingReader
now properly ignores marker packets- Encryption: File-related metadata (e.g. file name) moved to
ProducerOptions
pgpainless-cli/pgpainless-cli
executable script: Fix piping and parameter passingsop-java-picocli
: Addhelp
command- When changing passphrases: Subkeys with
GNU_DUMMY_S2K
will now be ignored
0.2.3
- Introduce new simplified decryption API
The new API (withOptions(ConsumerOptions)
) resembles the encryption API and is more friendly to dynamic construction of decryption properties
The old API has been deprecated and will be removed in a future release - Add
example
package in the JUnit tests
This package contains always-up-to-date usage examples for the PGPainless' API and various use cases - Add
KeyRingInfo.getVersion
- Add
CachingSecretKeyRingProtector.addPassphrase(OpenPgpV4Fingerprint, Passphrase)
- Make builds of all jars reproducible
- Fix
NullPointerException
inKeyRingInfo.getExpirationDateForUse()
0.2.2
- Fix bug where adding a subkey would ignore the user-requested key flags
This would cause subkeys to erroneously carry the certify-others key flag
0.2.1
- Bump Bouncycastle dependency to
1.69
This fixes a number of issues (#70, #72, #84). As a result the test suite should now run more smoothly \o/ - Remove Android SDK build dependency
We can now build PGPainless without the need to have the Android SDK installed SignatureUtils
: AddgetSignatureDigestPrefix()
method- Add
KeyIdUtil
which allows converting 16 digit hex fingerprints to key-ids SignatureSubpacketsUtil
: Add methods to get notations by name- Add public key algorithm policy to reject signatures made by weak signing keys