Merge pull request #21 from Seagate/feat/batchcount2

Refactor Batch Commands

kmip20/op_getattributes.go

@@ -2,6 +2,7 @@ package kmip20
 
 import (
 	"context"
+
 	"github.com/Seagate/kmip-go"
 )
 
@@ -10,15 +11,15 @@ import (
 // Table 196
 
 type GetAttributesRequestPayload struct {
-	UniqueIdentifier   *UniqueIdentifierValue // Required: No
-	Attributes         interface{}            // Required: No
+	UniqueIdentifier *UniqueIdentifierValue // Required: No
+	Attributes       interface{}            // Required: No
 }
 
 // Table 197
 
 type GetAttributesResponsePayload struct {
-	UniqueIdentifier  string      // Required: Yes
-	Attributes        interface{} // Required: No
+	UniqueIdentifier string      // Required: Yes
+	Attributes       interface{} // Required: No
 }
 
 type GetAttributesHandler struct {

kmip20/op_register.go

@@ -13,23 +13,23 @@ import (
 // Table 169
 
 type RegisterRequestPayload struct {
-	ObjectType              kmip14.ObjectType
-	Attributes              interface{}
-	Certificate             *kmip.Certificate
-	SymmetricKey            *kmip.SymmetricKey
-	PrivateKey              *kmip.PrivateKey
-	PublicKey               *kmip.PublicKey
-	SplitKey                *kmip.SplitKey
-	Template                *kmip.Template
-	SecretData              *kmip.SecretData
-	OpaqueObject            *kmip.OpaqueObject
-	ProtectionStorageMasks  uint32
+	ObjectType             kmip14.ObjectType
+	Attributes             interface{}
+	Certificate            *kmip.Certificate
+	SymmetricKey           *kmip.SymmetricKey
+	PrivateKey             *kmip.PrivateKey
+	PublicKey              *kmip.PublicKey
+	SplitKey               *kmip.SplitKey
+	Template               *kmip.Template
+	SecretData             *kmip.SecretData
+	OpaqueObject           *kmip.OpaqueObject
+	ProtectionStorageMasks uint32
 }
 
 // Table 170
 
 type RegisterResponsePayload struct {
-	UniqueIdentifier  string
+	UniqueIdentifier string
 }
 
 type RegisterHandler struct {

op_create.go

@@ -63,7 +63,8 @@ func (h *CreateHandler) HandleItem(ctx context.Context, req *Request) (*Response
 
 	idAttr := respPayload.TemplateAttribute.GetTag(kmip14.TagUniqueIdentifier)
 
-	req.IDPlaceholder, ok = idAttr.AttributeValue.(string)
+	// req.IDPlaceholder, ok = idAttr.AttributeValue.(string)
+	req.IDPlaceholder = respPayload.UniqueIdentifier
 	if !ok {
 		return nil, merry.Errorf("invalid response returned by CreateHandler: unique identifier tag in attributes should have been a string, was %t", idAttr.AttributeValue)
 	}

op_destroy.go

@@ -32,6 +32,7 @@ func (h *DestroyHandler) HandleItem(ctx context.Context, req *Request) (*Respons
 	}
 
 	// req.Key = respPayload.Key
+	req.IDPlaceholder = respPayload.UniqueIdentifier
 
 	return &ResponseBatchItem{
 		ResponsePayload: respPayload,

op_get.go

@@ -43,6 +43,7 @@ func (h *GetHandler) HandleItem(ctx context.Context, req *Request) (*ResponseBat
 	}
 
 	// req.Key = respPayload.Key
+	req.IDPlaceholder = respPayload.UniqueIdentifier
 
 	return &ResponseBatchItem{
 		ResponsePayload: respPayload,

op_locate.go

@@ -39,6 +39,8 @@ func (h *LocateHandler) HandleItem(ctx context.Context, req *Request) (*Response
 		return nil, err
 	}
 
+	req.IDPlaceholder = respPayload.UniqueIdentifier
+
 	return &ResponseBatchItem{
 		ResponsePayload: respPayload,
 	}, nil

op_query.go

@@ -14,6 +14,18 @@ type QueryRequestPayload struct {
 	QueryFunction []kmip14.QueryFunction
 }
 
+type CapabilityInformation struct {
+	StreamingCapability     bool                      // Required: No
+	AsynchronousCapability  bool                      // Required: No
+	AttestationCapability   bool                      // Required: No
+	BatchUndoCapability     bool                      // Required: No
+	BatchContinueCapability bool                      // Required: No
+	UnwrapMode              kmip14.UnwrapMode         // Required: No
+	DestroyAction           kmip14.DestroyAction      // Required: No
+	ShreddingAlgorithm      kmip14.ShreddingAlgorithm // Required: No
+	RNGMode                 kmip14.RNGMode            // Required: No
+}
+
 // Table 260
 
 type QueryResponsePayload struct {
@@ -27,7 +39,7 @@ type QueryResponsePayload struct {
 	RNGParameters            string
 	ProfileInformation       []kmip14.ProfileName
 	ValidationInformation    []kmip14.ValidationAuthorityType
-	CapabilityInformation    []string
+	CapabilityInformation    CapabilityInformation
 	ClientRegistrationMethod kmip14.ClientRegistrationMethod
 	DefaultsInformation      string
 	ProtectionStorageMasks   string

op_rekey.go

@@ -5,7 +5,6 @@ import (
 )
 
 // ReKeyRequestPayload ////////////////////////////////////////
-//
 type ReKeyRequestPayload struct {
 	UniqueIdentifier string
 }

op_revoke.go

@@ -46,6 +46,8 @@ func (h *RevokeHandler) HandleItem(ctx context.Context, req *Request) (*Response
 		return nil, err
 	}
 
+	req.IDPlaceholder = respPayload.UniqueIdentifier
+
 	return &ResponseBatchItem{
 		ResponsePayload: respPayload,
 	}, nil

src/handlers/handlers.go

@@ -36,7 +36,6 @@ func Initialize() {
 		"clear":        ClearKey,
 		"register":     RegisterKey,
 		"getattribute": GetAttribute,
-
 	}
 }
 

src/handlers/key.go

@@ -89,7 +89,7 @@ func LocateKey(ctx context.Context, settings *kmipapi.ConfigurationSettings, lin
 	attribvalue1 := kmipapi.GetValue(line, "attribvalue1")
 	attribname2 := kmipapi.GetValue(line, "attribname2")
 	attribvalue2 := kmipapi.GetValue(line, "attribvalue2")
-	
+
 	if id == "" && attribvalue2 == "" {
 		fmt.Printf("locate id, attribname2, and attribvalue2 are required, example: locate id=SASED-M-2-14-name attribname2=ObjectType attribvalue2=SecretData\n")
 		return
@@ -246,7 +246,7 @@ func GetAttribute(ctx context.Context, settings *kmipapi.ConfigurationSettings,
 		return
 	}
 	attribname1 := kmipapi.GetValue(line, "attribname1")
-	
+
 	uid, err := kmipapi.GetAttribute(ctx, settings, uid, attribname1)
 	if err != nil {
 		fmt.Printf("get attribute failed for uid (%s) with error: %v\n", uid, err)

src/kmipapi/clientapi.go

@@ -437,3 +437,35 @@ func ReKey(ctx context.Context, settings *ConfigurationSettings, uid string) (st
 
 	return kmipResp.UniqueIdentifier, nil
 }
+
+type (
+	CreateNullStruct struct{}
+	RevokeNullStruct struct {
+		RevocationReason kmip.RevocationReasonStruct // Required: Yes
+	}
+)
+
+type BatchListItem struct {
+	Operation      kmip14.Operation
+	RequestPayload interface{}
+}
+
+func BatchCmdCreateList() []kmip.RequestBatchItem {
+	var BatchList []kmip.RequestBatchItem
+	return BatchList
+}
+
+func BatchCmdAddItem(ctx context.Context, BatchList []kmip.RequestBatchItem, BatchItems BatchListItem, batchnum []byte, batchcount byte) ([]kmip.RequestBatchItem, []byte, error) {
+	logger := klog.FromContext(ctx)
+
+	batchnum = append(batchnum, byte(batchcount+1))
+	BatchList = append(BatchList, kmip.RequestBatchItem{
+		UniqueBatchItemID: batchnum[batchcount : batchcount+1],
+		Operation:         kmip14.Operation(BatchItems.Operation),
+		RequestPayload:    BatchItems.RequestPayload,
+	},
+	)
+	logger.V(2).Info("++ batch cmd add item", "BatchList", BatchList)
+
+	return BatchList, batchnum, nil
+}

src/kmipapi/clientops.go

@@ -25,6 +25,7 @@ type CreateKeyRequest struct {
 	Algorithm              kmip14.CryptographicAlgorithm
 	CryptographicLength    uint32
 	CryptographicUsageMask uint32
+	Operation              kmip14.Operation
 }
 
 type CreateKeyResponse struct {
@@ -41,7 +42,8 @@ type CreateKeyResponse struct {
 
 type DeleteKeyRequest struct {
 	// Contains all attributes of a caller request to delete a KMIP key.
-	Type kmip14.ObjectType
+	Type      kmip14.ObjectType
+	Operation kmip14.Operation
 }
 
 type DeleteKeyResponse struct {
@@ -53,6 +55,7 @@ type DeleteKeyResponse struct {
 type GetKeyRequest struct {
 	// Contains all attributes of a caller request to get a KMIP key.
 	UniqueIdentifier string
+	Operation        kmip14.Operation
 }
 
 type GetKeyResponse struct {
@@ -65,6 +68,7 @@ type GetKeyResponse struct {
 type DestroyKeyRequest struct {
 	// Contains all attributes of a caller request to destroy a KMIP key.
 	UniqueIdentifier string
+	Operation        kmip14.Operation
 }
 
 type DestroyKeyResponse struct {
@@ -75,6 +79,7 @@ type DestroyKeyResponse struct {
 type ActivateKeyRequest struct {
 	// Contains all attributes of a caller request to activate a KMIP key.
 	UniqueIdentifier string
+	Operation        kmip14.Operation
 }
 
 type ActivateKeyResponse struct {
@@ -87,6 +92,7 @@ type RevokeKeyRequest struct {
 	UniqueIdentifier string
 	RevocationReason uint32
 	CompromiseDate   time.Time // optional
+	Operation        kmip14.Operation
 }
 
 type RevokeKeyResponse struct {
@@ -135,11 +141,12 @@ type GetAttributeResponse struct {
 
 type LocateRequest struct {
 	// Contains all attributes of a caller request to revoke a KMIP key.
-	Name             string
-	AttribName1      string
-	AttribValue1     string
-	AttribName2      string
-	AttribValue2     string
+	Name         string
+	AttribName1  string
+	AttribValue1 string
+	AttribName2  string
+	AttribValue2 string
+	Operation    kmip14.Operation
 }
 
 type LocateResponse struct {
@@ -157,12 +164,12 @@ type QueryRequest struct {
 	QueryFunction []kmip14.QueryFunction
 	Id            string
 }
-
 type QueryResponse struct {
 	// Contains all attributes of the query response operation that are relevant to the caller.
-	Operation            []kmip14.Operation  `json:"Operation,omitempty"`
-	ObjectType           []kmip14.ObjectType `json:"Object Type,omitempty"`
-	VendorIdentification string              `json:"Vendor Identification,omitempty"`
+	Operation             []kmip14.Operation  `json:"Operation,omitempty"`
+	ObjectType            []kmip14.ObjectType `json:"Object Type,omitempty"`
+	VendorIdentification  string              `json:"Vendor Identification,omitempty"`
+	CapabilityInformation interface{}
 }
 
 type SetAttributeRequest struct {