Merge pull request #2984 from Baha-sk/rest-agent-mediatype

feat: add mediatype profiles and key types to agent-rest

Author: Firas Qutishat

cmd/aries-agent-rest/startcmd/start.go

@@ -32,6 +32,7 @@ import (
 	"github.com/hyperledger/aries-framework-go/pkg/framework/aries"
 	"github.com/hyperledger/aries-framework-go/pkg/framework/aries/defaults"
 	"github.com/hyperledger/aries-framework-go/pkg/framework/context"
+	"github.com/hyperledger/aries-framework-go/pkg/kms"
 	"github.com/hyperledger/aries-framework-go/pkg/vdr/httpbinding"
 	"github.com/hyperledger/aries-framework-go/spi/storage"
 )
@@ -170,6 +171,30 @@ const (
 		" Alternatively, this can be set with the following environment variable (in CSV format): " +
 		agentContextProviderEnvKey
 
+	// default verification key type flag.
+	agentKeyTypeFlagName = "key-type"
+	agentKeyTypeEnvKey   = "ARIESD_KEY_TYPE"
+	agentKeyTypeUsage    = "Default key type supported by this agent." +
+		" This flag sets the verification (and for DIDComm V1 encryption as well) key type used for key creation in the agent." + //nolint:lll
+		" Alternatively, this can be set with the following environment variable: " +
+		agentKeyTypeEnvKey
+
+	// default key agreement type flag.
+	agentKeyAgreementTypeFlagName = "key-agreement-type"
+	agentKeyAgreementTypeEnvKey   = "ARIESD_KEY_AGREEMENT_TYPE"
+	agentKeyAgreementTypeUsage    = "Default key agreement type supported by this agent." +
+		" Default encryption (used in DIDComm V2) key type used for key agreement creation in the agent." +
+		" Alternatively, this can be set with the following environment variable: " +
+		agentKeyAgreementTypeEnvKey
+
+	// media type profiles flag.
+	agentMediaTypeProfilesFlagName = "media-type-profiles"
+	agentMediaTypeProfilesEnvKey   = "ARIESD_MEDIA_TYPE_PROFILES"
+	agentMediaTypeProfilesUsage    = "Media Type Profiles supported by this agent." +
+		" This flag can be repeated, allowing setting up multiple profiles." +
+		" Alternatively, this can be set with the following environment variable (in CSV format): " +
+		agentMediaTypeProfilesEnvKey
+
 	httpProtocol      = "http"
 	websocketProtocol = "ws"
 
@@ -180,16 +205,35 @@ const (
 var (
 	errMissingHost = errors.New("host not provided")
 	logger         = log.New("aries-framework/agent-rest")
+
+	//nolint:gochecknoglobals
+	keyTypes = map[string]kms.KeyType{
+		"ed25519":           kms.ED25519Type,
+		"ecdsap256ieee1363": kms.ECDSAP256TypeIEEEP1363,
+		"ecdsap256der":      kms.ECDSAP256TypeDER,
+		"ecdsap384ieee1363": kms.ECDSAP384TypeIEEEP1363,
+		"ecdsap384der":      kms.ECDSAP384TypeDER,
+		"ecdsap521ieee1363": kms.ECDSAP521TypeIEEEP1363,
+		"ecdsap521der":      kms.ECDSAP521TypeDER,
+	}
+
+	//nolint:gochecknoglobals
+	keyAgreementTypes = map[string]kms.KeyType{
+		"x25519kw": kms.X25519ECDHKWType,
+		"p256kw":   kms.NISTP256ECDHKWType,
+		"p384kw":   kms.NISTP384ECDHKWType,
+		"p521kw":   kms.NISTP521ECDHKWType,
+	}
 )
 
 type agentParameters struct {
 	server                                         server
 	host, defaultLabel, transportReturnRoute       string
 	tlsCertFile, tlsKeyFile                        string
-	token                                          string
+	token, keyType, keyAgreementType               string
 	webhookURLs, httpResolvers, outboundTransports []string
 	inboundHostInternals, inboundHostExternals     []string
-	contextProviderURLs                            []string
+	contextProviderURLs, mediaTypeProfiles         []string
 	autoAccept                                     bool
 	msgHandler                                     command.MessageHandler
 	dbParam                                        *dbParam
@@ -332,6 +376,21 @@ func createStartCMD(server server) *cobra.Command { //nolint: funlen,gocyclo,goc
 				return err
 			}
 
+			keyType, err := getUserSetVar(cmd, agentKeyTypeFlagName, agentKeyTypeEnvKey, true)
+			if err != nil {
+				return err
+			}
+
+			keyAgreementType, err := getUserSetVar(cmd, agentKeyAgreementTypeFlagName, agentKeyAgreementTypeEnvKey, true)
+			if err != nil {
+				return err
+			}
+
+			mediaTypeProfiles, err := getUserSetVars(cmd, agentMediaTypeProfilesFlagName, agentMediaTypeProfilesEnvKey, true)
+			if err != nil {
+				return err
+			}
+
 			parameters := &agentParameters{
 				server:               server,
 				host:                 host,
@@ -349,6 +408,9 @@ func createStartCMD(server server) *cobra.Command { //nolint: funlen,gocyclo,goc
 				tlsCertFile:          tlsCertFile,
 				tlsKeyFile:           tlsKeyFile,
 				autoExecuteRFC0593:   autoExecuteRFC0593,
+				keyType:              keyType,
+				keyAgreementType:     keyAgreementType,
+				mediaTypeProfiles:    mediaTypeProfiles,
 			}
 
 			return startAgent(parameters)
@@ -417,6 +479,7 @@ func getAutoExecuteRFC0593(cmd *cobra.Command) (bool, error) {
 	return strconv.ParseBool(autoExecuteRFC0593Str)
 }
 
+//nolint:funlen
 func createFlags(startCmd *cobra.Command) {
 	// agent host flag
 	startCmd.Flags().StringP(agentHostFlagName, agentHostFlagShorthand, "", agentHostFlagUsage)
@@ -477,6 +540,12 @@ func createFlags(startCmd *cobra.Command) {
 
 	// db timeout
 	startCmd.Flags().StringP(databaseTimeoutFlagName, "", "", databaseTimeoutFlagUsage)
+
+	startCmd.Flags().StringP(agentKeyTypeFlagName, "", "", agentKeyTypeUsage)
+
+	startCmd.Flags().StringP(agentKeyAgreementTypeFlagName, "", "", agentKeyAgreementTypeUsage)
+
+	startCmd.Flags().StringSliceP(agentMediaTypeProfilesFlagName, "", []string{}, agentMediaTypeProfilesUsage)
 }
 
 func getUserSetVar(cmd *cobra.Command, flagName, envKey string, isOptional bool) (string, error) {
@@ -714,6 +783,7 @@ func startAgent(parameters *agentParameters) error {
 	return nil
 }
 
+//nolint:funlen,gocyclo
 func createAriesAgent(parameters *agentParameters) (*context.Provider, error) {
 	var opts []aries.Option
 
@@ -758,6 +828,18 @@ func createAriesAgent(parameters *agentParameters) (*context.Provider, error) {
 		opts = append(opts, aries.WithJSONLDContextProviderURL(parameters.contextProviderURLs...))
 	}
 
+	if kt, ok := keyTypes[parameters.keyType]; ok {
+		opts = append(opts, aries.WithKeyType(kt))
+	}
+
+	if kat, ok := keyAgreementTypes[parameters.keyAgreementType]; ok {
+		opts = append(opts, aries.WithKeyAgreementType(kat))
+	}
+
+	if len(parameters.mediaTypeProfiles) > 0 {
+		opts = append(opts, aries.WithMediaTypeProfiles(parameters.mediaTypeProfiles))
+	}
+
 	framework, err := aries.New(opts...)
 	if err != nil {
 		return nil, fmt.Errorf("failed to start aries agent rest on port [%s], failed to initialize framework :  %w",

cmd/aries-agent-rest/startcmd/start_test.go

@@ -22,6 +22,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/hyperledger/aries-framework-go/pkg/common/log"
+	"github.com/hyperledger/aries-framework-go/pkg/didcomm/transport"
 	spi "github.com/hyperledger/aries-framework-go/spi/log"
 )
 
@@ -687,6 +688,132 @@ func TestStartAriesTLS(t *testing.T) {
 	require.EqualError(t, errors.Unwrap(err), "open invalid: no such file or directory")
 }
 
+func TestCreateAriesWithKeyType(t *testing.T) {
+	tests := []struct {
+		name string
+		kt   string
+	}{
+		{
+			name: "test ed25519 key type",
+			kt:   "ed25519",
+		},
+		{
+			name: "test ecdsap256ieee1363 key type",
+			kt:   "ecdsap256ieee1363",
+		},
+		{
+			name: "test ecdsap256der key type",
+			kt:   "ecdsap256der",
+		},
+		{
+			name: "test ecdsap384ieee1363 key type",
+			kt:   "ecdsap384ieee1363",
+		},
+		{
+			name: "test ecdsap384der key type",
+			kt:   "ecdsap384der",
+		},
+		{
+			name: "test ecdsap521ieee1363 key type",
+			kt:   "ecdsap521ieee1363",
+		},
+		{
+			name: "test ecdsap521der key type",
+			kt:   "ecdsap521der",
+		},
+	}
+
+	for _, tt := range tests {
+		tc := tt
+		t.Run(tc.name, func(t *testing.T) {
+			parameters := &agentParameters{
+				dbParam: &dbParam{dbType: databaseTypeMemOption},
+				keyType: tc.kt,
+			}
+
+			ctx, err := createAriesAgent(parameters)
+			require.NoError(t, err)
+			require.EqualValues(t, ctx.KeyType(), keyTypes[tc.kt])
+		})
+	}
+}
+
+func TestCreateAriesWithKeyAgreementType(t *testing.T) {
+	tests := []struct {
+		name string
+		kt   string
+	}{
+		{
+			name: "test x25519kw key agreement type",
+			kt:   "x25519kw",
+		},
+		{
+			name: "test p256kw key agreement type",
+			kt:   "p256kw",
+		},
+		{
+			name: "test p384kw key agreement type",
+			kt:   "p384kw",
+		},
+		{
+			name: "test p521kw key agreement type",
+			kt:   "p521kw",
+		},
+	}
+
+	for _, tt := range tests {
+		tc := tt
+		t.Run(tc.name, func(t *testing.T) {
+			parameters := &agentParameters{
+				dbParam:          &dbParam{dbType: databaseTypeMemOption},
+				keyAgreementType: tc.kt,
+			}
+
+			ctx, err := createAriesAgent(parameters)
+			require.NoError(t, err)
+			require.EqualValues(t, ctx.KeyAgreementType(), keyAgreementTypes[tc.kt])
+		})
+	}
+}
+
+func TestCreateAriesWithMediaTypeProfiles(t *testing.T) {
+	tests := []struct {
+		name string
+		mtp  []string
+	}{
+		{
+			name: "test didcomm/v2 media type profile",
+			mtp:  []string{transport.MediaTypeDIDCommV2Profile},
+		},
+		{
+			name: "test didcomm/aip2;env=rfc19 media type profile",
+			mtp:  []string{transport.MediaTypeAIP2RFC0019Profile},
+		},
+		{
+			name: "test didcomm/aip2;env=rfc587 media type profile",
+			mtp:  []string{transport.MediaTypeAIP2RFC0587Profile},
+		},
+		{
+			name: "test didcomm/v2 and didcomm/aip2;env=rfc19 media type profiles",
+			mtp:  []string{transport.MediaTypeDIDCommV2Profile, transport.MediaTypeAIP2RFC0019Profile},
+		},
+	}
+
+	for _, tt := range tests {
+		tc := tt
+		t.Run(tc.name, func(t *testing.T) {
+			parameters := &agentParameters{
+				dbParam:           &dbParam{dbType: databaseTypeMemOption},
+				mediaTypeProfiles: tc.mtp,
+			}
+
+			ctx, err := createAriesAgent(parameters)
+			require.NoError(t, err)
+			require.EqualValues(t, ctx.MediaTypeProfiles(), tc.mtp)
+		})
+	}
+}
+
 func TestStartAriesWithAuthorization(t *testing.T) {
 	const (
 		goodToken = "ABCD"