Skip to content

Commit

Permalink
chore: Remove crypto refresh from code docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lubux committed Nov 6, 2024
1 parent be7f124 commit 7600503
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [3.0.0-alpha.0] 2024-01-18
### Added
- New simplified API that is not backward compatible.
- Full support for the crypto refresh.
- Full support for RFC9580 .
- Improved interoperability with other OpenPGP libraries.
- Streaming support for all operations.
- Introduces profiles for OpenPGP customization.
Expand Down
2 changes: 1 addition & 1 deletion crypto/encryption_handle.go
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ func (eh *encryptionHandle) validate() error {
func (eh *encryptionHandle) armorChecksumRequired() bool {
if !constants.ArmorChecksumEnabled {
// If the default behavior is no checksum, we can ignore
// the logic for the crypto refresh check.
// the logic for the RFC9580 check.
return false
}
encryptionConfig := eh.profile.EncryptionConfig()
Expand Down
4 changes: 2 additions & 2 deletions crypto/encryption_handle_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ func (ehb *EncryptionHandleBuilder) Password(password []byte) *EncryptionHandleB
// Compress indicates if the plaintext should be compressed before encryption.
// Compression affects security and opens the door for side-channel attacks, which
// might allow to extract the plaintext data without a decryption key.
// The openpgp crypto refresh recommends to not use compression.
// The RFC9580 recommends to not use compression.
func (ehb *EncryptionHandleBuilder) Compress() *EncryptionHandleBuilder {
ehb.handle.Compression = constants.DefaultCompression
return ehb
Expand All @@ -126,7 +126,7 @@ func (ehb *EncryptionHandleBuilder) Compress() *EncryptionHandleBuilder {
// CompressWith indicates if the plaintext should be compressed before encryption.
// Compression affects security and opens the door for side-channel attacks, which
// might allow to extract the plaintext data without a decryption key.
// The openpgp crypto refresh recommends to not use compression.
// The RFC9580 recommends to not use compression.
// Allowed config options:
// constants.NoCompression: none, constants.DefaultCompression: profile default
// constants.ZIPCompression: zip, constants.ZLIBCompression: zlib.
Expand Down
4 changes: 2 additions & 2 deletions crypto/key_generation.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ const (
KeyGenerationRSA4096 int = 1
// KeyGenerationC25519 allows to override the output key algorithm in key generation to curve25519.
KeyGenerationC25519 int = 2
// KeyGenerationC25519 allows to override the output key algorithm in key generation to curve25519 crypto refresh.
// KeyGenerationC25519 allows to override the output key algorithm in key generation to curve25519 RFC9580.
KeyGenerationC25519Refresh int = 3
// KeyGenerationC448 allows to override the output key algorithm in key generation to curve448.
KeyGenerationC448 int = 4
// KeyGenerationC448Refresh allows to override the output key algorithm in key generation to curve448 crypto refresh.
// KeyGenerationC448Refresh allows to override the output key algorithm in key generation to curve448 RFC9580.
KeyGenerationC448Refresh int = 5
)

Expand Down
2 changes: 1 addition & 1 deletion crypto/sign_handle.go
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ func (sh *signatureHandle) validate() error {
func (sh *signatureHandle) armorChecksumRequired() bool {
if !constants.ArmorChecksumEnabled {
// If the default behavior is no checksum, we can ignore
// the logic for the crypto refresh check.
// the logic for the RFC9580 check.
return false
}
if sh.SignKeyRing == nil {
Expand Down
2 changes: 1 addition & 1 deletion profile/preset.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func RFC4880() *Custom {
}

// RFC9580 returns a custom profile for this library
// that conforms with the algorithms in RFC9580 (crypto refresh).
// that conforms with the algorithms in RFC9580.
func RFC9580() *Custom {
setKeyAlgorithm := func(cfg *packet.Config, securityLevel int8) {
switch securityLevel {
Expand Down

0 comments on commit 7600503

Please sign in to comment.