mirrors/stfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: Use simpler error messages

Browse Source
This commit is contained in:
Felicitas Pojtinger
2021-12-09 17:48:57 +01:00
parent 20f30d0135
commit bc7793360f
12 changed files with 41 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/stbak/cmd/archive.go
View File

@@ -135,7 +135,7 @@ var archiveCmd = &cobra.Command{
}
if len(hdrs) <= i-1 {
return config.ErrMissingTarHeader
return config.ErrTarHeaderMissing
}
*hdr = *hdrs[i-1]

2
cmd/stbak/cmd/update.go
View File

@@ -118,7 +118,7 @@ var updateCmd = &cobra.Command{
}
if len(hdrs) <= i-1 {
return config.ErrMissingTarHeader
return config.ErrTarHeaderMissing
}
*hdr = *hdrs[i-1]

4
internal/compression/compress.go
View File

@@ -51,7 +51,7 @@ func Compress(
}
if !isRegular {
return nil, config.ErrCompressionFormatOnlyRegularSupport // "device or resource busy"
return nil, config.ErrCompressionFormatRegularOnly // "device or resource busy"
}
l := pgzip.DefaultCompression
@@ -131,7 +131,7 @@ func Compress(
return zz, nil
case config.CompressionFormatBrotliKey:
if !isRegular {
return nil, config.ErrCompressionFormatOnlyRegularSupport // "cannot allocate memory"
return nil, config.ErrCompressionFormatRegularOnly // "cannot allocate memory"
}
l := brotli.DefaultCompression

4
internal/encryption/decrypt.go
View File

@@ -60,12 +60,12 @@ func DecryptHeader(
}
if hdr.PAXRecords == nil {
return config.ErrEmbeddedHeaderMissing
return config.ErrTarHeaderEmbeddedMissing
}
encryptedEmbeddedHeader, ok := hdr.PAXRecords[records.STFSRecordEmbeddedHeader]
if !ok {
return config.ErrEmbeddedHeaderMissing
return config.ErrTarHeaderEmbeddedMissing
}
embeddedHeader, err := DecryptString(encryptedEmbeddedHeader, encryptionFormat, identity)

7
internal/records/stfs.go
View File

@@ -1,7 +1,5 @@
package records
import "errors"
const (
STFSPrefix = "STFS."
@@ -25,8 +23,3 @@ const (
STFSRecordEmbeddedHeader = STFSPrefix + "EmbeddedHeader"
)
var (
ErrUnsupportedVersion = errors.New("unsupported STFS version")
ErrUnsupportedAction = errors.New("unsupported STFS action")
)

4
internal/signature/sign.go
View File

@@ -23,7 +23,7 @@ func Sign(
switch signatureFormat {
case config.SignatureFormatMinisignKey:
if !isRegular {
return nil, nil, config.ErrSignatureFormatOnlyRegularSupport
return nil, nil, config.ErrSignatureFormatRegularOnly
}
identity, ok := identity.(minisign.PrivateKey)
@@ -126,7 +126,7 @@ func SignString(
switch signatureFormat {
case config.SignatureFormatMinisignKey:
if !isRegular {
return "", config.ErrSignatureFormatOnlyRegularSupport
return "", config.ErrSignatureFormatRegularOnly
}
identity, ok := identity.(minisign.PrivateKey)

8
internal/signature/verify.go
View File

@@ -24,7 +24,7 @@ func Verify(
switch signatureFormat {
case config.SignatureFormatMinisignKey:
if !isRegular {
return nil, nil, config.ErrSignatureFormatOnlyRegularSupport
return nil, nil, config.ErrSignatureFormatRegularOnly
}
recipient, ok := recipient.(minisign.PublicKey)
@@ -99,12 +99,12 @@ func VerifyHeader(
}
if hdr.PAXRecords == nil {
return config.ErrEmbeddedHeaderMissing
return config.ErrTarHeaderEmbeddedMissing
}
embeddedHeader, ok := hdr.PAXRecords[records.STFSRecordEmbeddedHeader]
if !ok {
return config.ErrEmbeddedHeaderMissing
return config.ErrTarHeaderEmbeddedMissing
}
signature, ok := hdr.PAXRecords[records.STFSRecordSignature]
@@ -136,7 +136,7 @@ func VerifyString(
switch signatureFormat {
case config.SignatureFormatMinisignKey:
if !isRegular {
return config.ErrSignatureFormatOnlyRegularSupport
return config.ErrSignatureFormatRegularOnly
}
recipient, ok := recipient.(minisign.PublicKey)

41
pkg/config/error.go
View File

@@ -3,30 +3,33 @@ package config
import "errors"
var (
ErrEncryptionFormatUnknown = errors.New("unknown encryption format")
ErrEncryptionFormatUnsupported = errors.New("unsupported encryption format")
ErrEncryptionFormatUnknown = errors.New("encryption format unknown")
ErrSignatureFormatUnknown = errors.New("signature format unknown")
ErrCompressionFormatUnknown = errors.New("compression format unknown")
ErrEncryptionFormatUnsupported = errors.New("encryption format unsupported")
ErrSignatureFormatUnsupported = errors.New("signature format unsupported")
ErrCompressionFormatUnsupported = errors.New("compression format unsupported")
ErrSignatureFormatRegularOnly = errors.New("signature format only supports regular files, not tape drives")
ErrSignatureInvalid = errors.New("signature invalid")
ErrSignatureMissing = errors.New("signature missing")
ErrCompressionFormatRegularOnly = errors.New("compression format only supports regular files, not tape drives")
ErrCompressionFormatRequiresLargerRecordSize = errors.New("compression format requires larger record size")
ErrCompressionLevelUnsupported = errors.New("compression level unsupported")
ErrCompressionLevelUnknown = errors.New("compression level unknown")
ErrIdentityUnparsable = errors.New("identity could not be parsed")
ErrRecipientUnparsable = errors.New("recipient could not be parsed")
ErrEmbeddedHeaderMissing = errors.New("embedded header is missing")
ErrKeygenFormatUnsupported = errors.New("key generation for format unsupported")
ErrSignatureFormatUnknown = errors.New("unknown signature format")
ErrSignatureFormatUnsupported = errors.New("unsupported signature format")
ErrSignatureFormatOnlyRegularSupport = errors.New("this signature format only supports regular files, not i.e. tape drives")
ErrSignatureInvalid = errors.New("signature is invalid")
ErrSignatureMissing = errors.New("signature is missing")
ErrTarHeaderMissing = errors.New("tar header missing")
ErrTarHeaderEmbeddedMissing = errors.New("embedded tar header missing")
ErrKeygenForFormatUnsupported = errors.New("can not generate keys for this format")
ErrTapeDrivesUnsupported = errors.New("system unsupported for tape drives")
ErrCompressionFormatUnknown = errors.New("unknown compression format")
ErrCompressionFormatUnsupported = errors.New("unsupported compression format")
ErrCompressionFormatOnlyRegularSupport = errors.New("this compression format only supports regular files, not i.e. tape drives")
ErrCompressionFormatRequiresLargerRecordSize = errors.New("this compression format requires a larger record size")
ErrCompressionLevelUnsupported = errors.New("compression level is unsupported")
ErrCompressionLevelUnknown = errors.New("unknown compression level")
ErrMissingTarHeader = errors.New("tar header is missing")
ErrDrivesUnsupported = errors.New("this system does not support tape drives")
ErrSTFSVersionUnsupported = errors.New("STFS version unsupported")
ErrSTFSActionUnsupported = errors.New("STFS action unsupported")
)

2
pkg/operations/delete.go
View File

@@ -112,7 +112,7 @@ func Delete(
}
if len(hdrs) <= i-1 {
return config.ErrMissingTarHeader
return config.ErrTarHeaderMissing
}
*hdr = *hdrs[i-1]

2
pkg/operations/move.go
View File

@@ -116,7 +116,7 @@ func Move(
}
if len(hdrs) <= i-1 {
return config.ErrMissingTarHeader
return config.ErrTarHeaderMissing
}
*hdr = *hdrs[i-1]

4
pkg/recovery/index.go
View File

@@ -360,10 +360,10 @@ func indexHeader(
}
default:
return records.ErrUnsupportedAction
return config.ErrSTFSActionUnsupported
}
default:
return records.ErrUnsupportedVersion
return config.ErrSTFSVersionUnsupported
}
return nil

6
pkg/utility/keygen.go
View File

@@ -34,7 +34,7 @@ func Keygen(
privkey = priv
pubkey = pub
} else {
return []byte{}, []byte{}, config.ErrKeygenForFormatUnsupported
return []byte{}, []byte{}, config.ErrKeygenFormatUnsupported
}
return privkey, pubkey, nil
@@ -106,7 +106,7 @@ func generateEncryptionKey(
return priv, pub, nil
default:
return []byte{}, []byte{}, config.ErrKeygenForFormatUnsupported
return []byte{}, []byte{}, config.ErrKeygenFormatUnsupported
}
}
@@ -130,6 +130,6 @@ func generateSignatureKey(
case config.SignatureFormatPGPKey:
return generateEncryptionKey(signatureFormat, password)
default:
return []byte{}, []byte{}, config.ErrKeygenForFormatUnsupported
return []byte{}, []byte{}, config.ErrKeygenFormatUnsupported
}
}