Skip to content

Commit

Permalink
Merge pull request #14 from MGTheTrain/feature/secure-file-storage
Browse files Browse the repository at this point in the history 
Refactoring and naming conventions
  • Loading branch information
@MGTheTrain
MGTheTrain authored Nov 19, 2024
2 parents 06ea246 + f0baefd commit b9f74df
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 33 deletions.
18 changes: 9 additions & 9 deletions cmd/crypto-vault-cli/internal/commands/pkcs11-commands.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ func IsTokenSetCmd(cmd *cobra.Command, args []string) {
modulePath, _ := cmd.Flags().GetString("module")
Label, _ := cmd.Flags().GetString("token-label")

token := &cryptography.PKCS11Token{
token := &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
}
Expand All @@ -30,7 +30,7 @@ func IsObjectSetCmd(cmd *cobra.Command, args []string) {
objectLabel, _ := cmd.Flags().GetString("object-label")
userPin, _ := cmd.Flags().GetString("user-pin")

token := &cryptography.PKCS11Token{
token := &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
ObjectLabel: objectLabel,
Expand All @@ -51,7 +51,7 @@ func InitializeTokenCmd(cmd *cobra.Command, args []string) {
soPin, _ := cmd.Flags().GetString("so-pin")
userPin, _ := cmd.Flags().GetString("user-pin")

token := &cryptography.PKCS11Token{
token := &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
SOPin: soPin,
Expand All @@ -72,7 +72,7 @@ func AddKeyCmd(cmd *cobra.Command, args []string) {
keySize, _ := cmd.Flags().GetInt("key-size")
userPin, _ := cmd.Flags().GetString("user-pin")

token := &cryptography.PKCS11Token{
token := &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
ObjectLabel: objectLabel,
Expand All @@ -94,7 +94,7 @@ func DeleteObjectCmd(cmd *cobra.Command, args []string) {
objectType, _ := cmd.Flags().GetString("object-type")
userPin, _ := cmd.Flags().GetString("user-pin")

token := &cryptography.PKCS11Token{
token := &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
ObjectLabel: objectLabel,
Expand All @@ -116,7 +116,7 @@ func EncryptCmd(cmd *cobra.Command, args []string) {
inputFilePath, _ := cmd.Flags().GetString("input-file")
outputFilePath, _ := cmd.Flags().GetString("output-file")

token := &cryptography.PKCS11Token{
token := &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
ObjectLabel: objectLabel,
Expand All @@ -139,7 +139,7 @@ func DecryptCmd(cmd *cobra.Command, args []string) {
inputFilePath, _ := cmd.Flags().GetString("input-file")
outputFilePath, _ := cmd.Flags().GetString("output-file")

token := &cryptography.PKCS11Token{
token := &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
ObjectLabel: objectLabel,
Expand All @@ -162,7 +162,7 @@ func SignCmd(cmd *cobra.Command, args []string) {
inputFilePath, _ := cmd.Flags().GetString("input-file")
outputFilePath, _ := cmd.Flags().GetString("output-file")

token := &cryptography.PKCS11Token{
token := &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
ObjectLabel: objectLabel,
Expand All @@ -185,7 +185,7 @@ func VerifyCmd(cmd *cobra.Command, args []string) {
dataFilePath, _ := cmd.Flags().GetString("data-file")
signatureFilePath, _ := cmd.Flags().GetString("signature-file")

token := &cryptography.PKCS11Token{
token := &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
ObjectLabel: objectLabel,
Expand Down
4 changes: 2 additions & 2 deletions internal/infrastructure/cryptography/aes.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import (

// AES Interface
type AES interface {
Encrypt(plainText []byte, key []byte) ([]byte, error)
Decrypt(ciphertext []byte, key []byte) ([]byte, error)
Encrypt(plainText, key []byte) ([]byte, error)
Decrypt(ciphertext, key []byte) ([]byte, error)
GenerateKey(keySize int) ([]byte, error)
}

Expand Down
32 changes: 16 additions & 16 deletions internal/infrastructure/cryptography/pkcs11.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import (
"strings"
)

// PKCS11TokenInterface defines the operations for working with a PKCS#11 token
type PKCS11TokenInterface interface {
// PKCS11Token defines the operations for working with a PKCS#11 token
type PKCS11Token interface {
IsTokenSet() (bool, error)
IsObjectSet() (bool, error)
InitializeToken(slot string) error
Expand All @@ -20,8 +20,8 @@ type PKCS11TokenInterface interface {
DeleteObject(objectType, objectLabel string) error
}

// PKCS11Token represents the parameters and operations for interacting with a PKCS#11 token
type PKCS11Token struct {
// PKCS11TokenImpl represents the parameters and operations for interacting with a PKCS#11 token
type PKCS11TokenImpl struct {
ModulePath string
Label string
SOPin string
Expand All @@ -32,7 +32,7 @@ type PKCS11Token struct {
}

// Public method to execute pkcs11-tool commands and return output
func (token *PKCS11Token) executePKCS11ToolCommand(args []string) (string, error) {
func (token *PKCS11TokenImpl) executePKCS11ToolCommand(args []string) (string, error) {
cmd := exec.Command("pkcs11-tool", args...)
output, err := cmd.CombinedOutput()
if err != nil {
Expand All @@ -42,7 +42,7 @@ func (token *PKCS11Token) executePKCS11ToolCommand(args []string) (string, error
}

// IsTokenSet checks if the token exists in the given module path
func (token *PKCS11Token) IsTokenSet() (bool, error) {
func (token *PKCS11TokenImpl) IsTokenSet() (bool, error) {
if token.ModulePath == "" || token.Label == "" {
return false, fmt.Errorf("missing module path or token label")
}
Expand All @@ -63,7 +63,7 @@ func (token *PKCS11Token) IsTokenSet() (bool, error) {
}

// IsObjectSet checks if the specified object exists on the given token
func (token *PKCS11Token) IsObjectSet() (bool, error) {
func (token *PKCS11TokenImpl) IsObjectSet() (bool, error) {
if token.ModulePath == "" || token.Label == "" || token.ObjectLabel == "" || token.UserPin == "" {
return false, fmt.Errorf("missing required arguments")
}
Expand All @@ -84,7 +84,7 @@ func (token *PKCS11Token) IsObjectSet() (bool, error) {
}

// InitializeToken initializes the token with the provided label and pins
func (token *PKCS11Token) InitializeToken(slot string) error {
func (token *PKCS11TokenImpl) InitializeToken(slot string) error {
if token.ModulePath == "" || token.Label == "" || token.SOPin == "" || token.UserPin == "" || slot == "" {
return fmt.Errorf("missing required parameters for token initialization")
}
Expand Down Expand Up @@ -112,7 +112,7 @@ func (token *PKCS11Token) InitializeToken(slot string) error {
}

// DeleteObject deletes a key or object from the token
func (token *PKCS11Token) DeleteObject(objectType, objectLabel string) error {
func (token *PKCS11TokenImpl) DeleteObject(objectType, objectLabel string) error {
if token.ModulePath == "" || token.Label == "" || objectLabel == "" || token.UserPin == "" {
return fmt.Errorf("missing required arguments to delete object")
}
Expand Down Expand Up @@ -150,7 +150,7 @@ func (token *PKCS11Token) DeleteObject(objectType, objectLabel string) error {
}

// AddKey adds the selected key (ECDSA or RSA) to the token
func (token *PKCS11Token) AddKey() error {
func (token *PKCS11TokenImpl) AddKey() error {
if token.ModulePath == "" || token.Label == "" || token.ObjectLabel == "" || token.UserPin == "" {
return fmt.Errorf("missing required arguments")
}
Expand All @@ -166,7 +166,7 @@ func (token *PKCS11Token) AddKey() error {
}

// addECDSASignKey adds an ECDSA signing key to the token
func (token *PKCS11Token) addECDSASignKey() error {
func (token *PKCS11TokenImpl) addECDSASignKey() error {
if token.KeySize != 256 && token.KeySize != 384 && token.KeySize != 521 {
return fmt.Errorf("ECDSA key size must be one of 256, 384, or 521 bits, but got %d", token.KeySize)
}
Expand Down Expand Up @@ -205,7 +205,7 @@ func (token *PKCS11Token) addECDSASignKey() error {
}

// addRSASignKey adds an RSA signing key to the token
func (token *PKCS11Token) addRSASignKey() error {
func (token *PKCS11TokenImpl) addRSASignKey() error {
// Supported RSA key sizes (for example, 2048, 3072, and 4096)
supportedRSASizes := []int{2048, 3072, 4096}

Expand Down Expand Up @@ -240,7 +240,7 @@ func (token *PKCS11Token) addRSASignKey() error {
}

// Encrypt encrypts data using the cryptographic capabilities of the PKCS#11 token. Refer to: https://docs.yubico.com/hardware/yubihsm-2/hsm-2-user-guide/hsm2-openssl-libp11.html#rsa-pkcs
func (token *PKCS11Token) Encrypt(inputFilePath, outputFilePath string) error {
func (token *PKCS11TokenImpl) Encrypt(inputFilePath, outputFilePath string) error {
// Validate required parameters
if token.ModulePath == "" || token.Label == "" || token.ObjectLabel == "" || token.UserPin == "" {
return fmt.Errorf("missing required arguments for encryption")
Expand Down Expand Up @@ -271,7 +271,7 @@ func (token *PKCS11Token) Encrypt(inputFilePath, outputFilePath string) error {
}

// Decrypt decrypts data using the cryptographic capabilities of the PKCS#11 token. Refer to: https://docs.yubico.com/hardware/yubihsm-2/hsm-2-user-guide/hsm2-openssl-libp11.html#rsa-pkcs
func (token *PKCS11Token) Decrypt(inputFilePath, outputFilePath string) error {
func (token *PKCS11TokenImpl) Decrypt(inputFilePath, outputFilePath string) error {
// Validate required parameters
if token.ModulePath == "" || token.Label == "" || token.ObjectLabel == "" || token.UserPin == "" {
return fmt.Errorf("missing required arguments for decryption")
Expand Down Expand Up @@ -307,7 +307,7 @@ func (token *PKCS11Token) Decrypt(inputFilePath, outputFilePath string) error {
}

// Sign signs data using the cryptographic capabilities of the PKCS#11 token. Refer to: https://docs.yubico.com/hardware/yubihsm-2/hsm-2-user-guide/hsm2-openssl-libp11.html#rsa-pss
func (token *PKCS11Token) Sign(inputFilePath, outputFilePath string) error {
func (token *PKCS11TokenImpl) Sign(inputFilePath, outputFilePath string) error {
// Validate required parameters
if token.ModulePath == "" || token.Label == "" || token.ObjectLabel == "" || token.UserPin == "" {
return fmt.Errorf("missing required arguments for signing")
Expand Down Expand Up @@ -356,7 +356,7 @@ func (token *PKCS11Token) Sign(inputFilePath, outputFilePath string) error {
}

// Verify verifies the signature of data using the cryptographic capabilities of the PKCS#11 token. Refer to: https://docs.yubico.com/hardware/yubihsm-2/hsm-2-user-guide/hsm2-openssl-libp11.html#rsa-pss
func (token *PKCS11Token) Verify(dataFilePath, signatureFilePath string) (bool, error) {
func (token *PKCS11TokenImpl) Verify(dataFilePath, signatureFilePath string) (bool, error) {
valid := false

// Validate required parameters
Expand Down
8 changes: 4 additions & 4 deletions internal/infrastructure/cryptography/pkcs11_archived.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package cryptography
// For reference only, to demonstrate experiments with pkcs11-tool for encryption, decryption, signing, and verification.

// // Encrypt encrypts data using the cryptographic capabilities of the PKCS#11 token. Currently only supports RSA keys. Refer to: https://docs.nitrokey.com/nethsm/pkcs11-tool#pkcs11-tool
// func (token *PKCS11Token) Encrypt(inputFilePath, outputFilePath string) error {
// func (token *PKCS11TokenImpl) Encrypt(inputFilePath, outputFilePath string) error {
// // Validate required parameters
// if token.ModulePath == "" || token.Label == "" || token.ObjectLabel == "" || token.UserPin == "" {
// return fmt.Errorf("missing required arguments for encryption")
Expand Down Expand Up @@ -55,7 +55,7 @@ package cryptography
// }

// // Decrypt decrypts data using the cryptographic capabilities of the PKCS#11 token. Currently only supports RSA keys. Refer to: https://docs.nitrokey.com/nethsm/pkcs11-tool#pkcs11-tool
// func (token *PKCS11Token) Decrypt(inputFilePath, outputFilePath string) error {
// func (token *PKCS11TokenImpl) Decrypt(inputFilePath, outputFilePath string) error {
// // Validate required parameters
// if token.ModulePath == "" || token.Label == "" || token.ObjectLabel == "" || token.UserPin == "" {
// return fmt.Errorf("missing required arguments for decryption")
Expand Down Expand Up @@ -121,7 +121,7 @@ package cryptography
// }

// // Sign signs data using the cryptographic capabilities of the PKCS#11 token. Currently only supports RSA keys. Refer to: https://docs.nitrokey.com/nethsm/pkcs11-tool#pkcs11-tool
// func (token *PKCS11Token) Sign(inputFilePath, outputFilePath string) error {
// func (token *PKCS11TokenImpl) Sign(inputFilePath, outputFilePath string) error {
// // Validate required parameters
// if token.ModulePath == "" || token.Label == "" || token.ObjectLabel == "" || token.UserPin == "" {
// return fmt.Errorf("missing required arguments for signing")
Expand Down Expand Up @@ -185,7 +185,7 @@ package cryptography
// }

// // Verify verifies the signature of data using the cryptographic capabilities of the PKCS#11 token.
// func (token *PKCS11Token) Verify(dataFilePath, signatureFilePath string) (bool, error) {
// func (token *PKCS11TokenImpl) Verify(dataFilePath, signatureFilePath string) (bool, error) {
// valid := false
// // Validate required parameters
// if token.ModulePath == "" || token.Label == "" || token.ObjectLabel == "" || token.UserPin == "" {
Expand Down
0 ...persistence/repository/blob_repository.go → internal/persistence/repository/blob.go
View file
File renamed without changes.
0 .../persistence/repository/key_repository.go → internal/persistence/repository/key.go
View file
File renamed without changes.
4 changes: 2 additions & 2 deletions test/integration/infrastructure/cryptography/pkcs11_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ import (

type PKCS11Test struct {
Slot string
Token *cryptography.PKCS11Token
Token *cryptography.PKCS11TokenImpl
}

// NewPKCS11Test sets up the test environment for PKCS#11 integration tests
func NewPKCS11Test(slot, modulePath, Label, soPin, userPin, objectLabel, keyType string, keySize int) *PKCS11Test {
return &PKCS11Test{
Slot: slot,
Token: &cryptography.PKCS11Token{
Token: &cryptography.PKCS11TokenImpl{
ModulePath: modulePath,
Label: Label,
SOPin: soPin,
Expand Down
0 ...istence/blob_repository_in_memory_test.go → ...istence/repository/blob_in_memory_test.go
View file
File renamed without changes.
0 ...sistence/key_repository_in_memory_test.go → ...sistence/repository/key_in_memory_test.go
View file
File renamed without changes.
0 test/integration/persistence/test_context.go → ...on/persistence/repository/test_context.go
View file
File renamed without changes.

0 comments on commit b9f74df

Please sign in to comment.