/
api_op_VerifyPinData.go
232 lines (207 loc) · 7.36 KB
/
api_op_VerifyPinData.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
// Code generated by smithy-go-codegen DO NOT EDIT.
package paymentcryptographydata
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/paymentcryptographydata/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Verifies pin-related data such as PIN and PIN Offset using algorithms including
// VISA PVV and IBM3624. For more information, see [Verify PIN data]in the Amazon Web Services
// Payment Cryptography User Guide.
//
// This operation verifies PIN data for user payment card. A card holder PIN data
// is never transmitted in clear to or from Amazon Web Services Payment
// Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN
// Offset generation and then encrypts it using PIN Encryption Key (PEK) to create
// an EncryptedPinBlock for transmission from Amazon Web Services Payment
// Cryptography.
//
// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon
// Web Services Payment Cryptography User Guide.
//
// Cross-account use: This operation can't be used across different Amazon Web
// Services accounts.
//
// Related operations:
//
// # GeneratePinData
//
// # TranslatePinData
//
// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html
// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html
// [Verify PIN data]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-pin-data.html
func (c *Client) VerifyPinData(ctx context.Context, params *VerifyPinDataInput, optFns ...func(*Options)) (*VerifyPinDataOutput, error) {
if params == nil {
params = &VerifyPinDataInput{}
}
result, metadata, err := c.invokeOperation(ctx, "VerifyPinData", params, optFns, c.addOperationVerifyPinDataMiddlewares)
if err != nil {
return nil, err
}
out := result.(*VerifyPinDataOutput)
out.ResultMetadata = metadata
return out, nil
}
type VerifyPinDataInput struct {
// The encrypted PIN block data that Amazon Web Services Payment Cryptography
// verifies.
//
// This member is required.
EncryptedPinBlock *string
// The keyARN of the encryption key under which the PIN block data is encrypted.
// This key type can be PEK or BDK.
//
// This member is required.
EncryptionKeyIdentifier *string
// The PIN encoding format for pin data generation as specified in ISO 9564.
// Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3 .
//
// The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and
// ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports
// a PIN from 4 to 12 digits in length.
//
// The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the
// fill digits are random values from 10 to 15.
//
// This member is required.
PinBlockFormat types.PinBlockFormatForPinData
// The Primary Account Number (PAN), a unique identifier for a payment credit or
// debit card that associates the card with a specific account holder.
//
// This member is required.
PrimaryAccountNumber *string
// The attributes and values for PIN data verification.
//
// This member is required.
VerificationAttributes types.PinVerificationAttributes
// The keyARN of the PIN verification key.
//
// This member is required.
VerificationKeyIdentifier *string
// The attributes and values for the DUKPT encrypted PIN block data.
DukptAttributes *types.DukptAttributes
// The length of PIN being verified.
PinDataLength *int32
noSmithyDocumentSerde
}
type VerifyPinDataOutput struct {
// The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for
// encrypted pin block generation.
//
// This member is required.
EncryptionKeyArn *string
// The key check value (KCV) of the encryption key. The KCV is used to check if
// all parties holding a given key have the same key or to detect that a key has
// changed.
//
// Amazon Web Services Payment Cryptography computes the KCV according to the CMAC
// specification.
//
// This member is required.
EncryptionKeyCheckValue *string
// The keyARN of the PIN encryption key that Amazon Web Services Payment
// Cryptography uses for PIN or PIN Offset verification.
//
// This member is required.
VerificationKeyArn *string
// The key check value (KCV) of the encryption key. The KCV is used to check if
// all parties holding a given key have the same key or to detect that a key has
// changed.
//
// Amazon Web Services Payment Cryptography computes the KCV according to the CMAC
// specification.
//
// This member is required.
VerificationKeyCheckValue *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationVerifyPinDataMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpVerifyPinData{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpVerifyPinData{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "VerifyPinData"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpVerifyPinDataValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opVerifyPinData(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opVerifyPinData(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "VerifyPinData",
}
}