/
mfaTotp.go
417 lines (362 loc) · 15.4 KB
/
mfaTotp.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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
package vault
import (
"context"
"reflect"
"errors"
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/internal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// Provides a resource to manage [TOTP MFA](https://www.vaultproject.io/docs/enterprise/mfa/mfa-totp).
//
// **Note** this feature is available only with Vault Enterprise.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-vault/sdk/v5/go/vault"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := vault.NewMfaTotp(ctx, "myTotp", &vault.MfaTotpArgs{
// Algorithm: pulumi.String("SHA256"),
// Digits: pulumi.Int(8),
// Issuer: pulumi.String("hashicorp"),
// KeySize: pulumi.Int(20),
// Period: pulumi.Int(60),
// })
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
//
// ## Import
//
// Mounts can be imported using the `path`, e.g.
//
// ```sh
//
// $ pulumi import vault:index/mfaTotp:MfaTotp my_totp my_totp
//
// ```
type MfaTotp struct {
pulumi.CustomResourceState
// `(string)` - Specifies the hashing algorithm used to generate the TOTP code.
// Options include `SHA1`, `SHA256` and `SHA512`
Algorithm pulumi.StringPtrOutput `pulumi:"algorithm"`
// `(int)` - The number of digits in the generated TOTP token.
// This value can either be 6 or 8.
Digits pulumi.IntPtrOutput `pulumi:"digits"`
// `(string: <required>)` - The name of the key's issuing organization.
Issuer pulumi.StringOutput `pulumi:"issuer"`
// `(int)` - Specifies the size in bytes of the generated key.
KeySize pulumi.IntPtrOutput `pulumi:"keySize"`
// `(string: <required>)` – Name of the MFA method.
Name pulumi.StringOutput `pulumi:"name"`
// The namespace to provision the resource in.
// The value should not contain leading or trailing forward slashes.
// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
// *Available only for Vault Enterprise*.
Namespace pulumi.StringPtrOutput `pulumi:"namespace"`
// `(int)` - The length of time used to generate a counter for the TOTP token calculation.
Period pulumi.IntPtrOutput `pulumi:"period"`
// `(int)` - The pixel size of the generated square QR code.
QrSize pulumi.IntPtrOutput `pulumi:"qrSize"`
// `(int)` - The number of delay periods that are allowed when validating a TOTP token.
// This value can either be 0 or 1.
Skew pulumi.IntPtrOutput `pulumi:"skew"`
}
// NewMfaTotp registers a new resource with the given unique name, arguments, and options.
func NewMfaTotp(ctx *pulumi.Context,
name string, args *MfaTotpArgs, opts ...pulumi.ResourceOption) (*MfaTotp, error) {
if args == nil {
return nil, errors.New("missing one or more required arguments")
}
if args.Issuer == nil {
return nil, errors.New("invalid value for required argument 'Issuer'")
}
opts = internal.PkgResourceDefaultOpts(opts)
var resource MfaTotp
err := ctx.RegisterResource("vault:index/mfaTotp:MfaTotp", name, args, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// GetMfaTotp gets an existing MfaTotp resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetMfaTotp(ctx *pulumi.Context,
name string, id pulumi.IDInput, state *MfaTotpState, opts ...pulumi.ResourceOption) (*MfaTotp, error) {
var resource MfaTotp
err := ctx.ReadResource("vault:index/mfaTotp:MfaTotp", name, id, state, &resource, opts...)
if err != nil {
return nil, err
}
return &resource, nil
}
// Input properties used for looking up and filtering MfaTotp resources.
type mfaTotpState struct {
// `(string)` - Specifies the hashing algorithm used to generate the TOTP code.
// Options include `SHA1`, `SHA256` and `SHA512`
Algorithm *string `pulumi:"algorithm"`
// `(int)` - The number of digits in the generated TOTP token.
// This value can either be 6 or 8.
Digits *int `pulumi:"digits"`
// `(string: <required>)` - The name of the key's issuing organization.
Issuer *string `pulumi:"issuer"`
// `(int)` - Specifies the size in bytes of the generated key.
KeySize *int `pulumi:"keySize"`
// `(string: <required>)` – Name of the MFA method.
Name *string `pulumi:"name"`
// The namespace to provision the resource in.
// The value should not contain leading or trailing forward slashes.
// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
// *Available only for Vault Enterprise*.
Namespace *string `pulumi:"namespace"`
// `(int)` - The length of time used to generate a counter for the TOTP token calculation.
Period *int `pulumi:"period"`
// `(int)` - The pixel size of the generated square QR code.
QrSize *int `pulumi:"qrSize"`
// `(int)` - The number of delay periods that are allowed when validating a TOTP token.
// This value can either be 0 or 1.
Skew *int `pulumi:"skew"`
}
type MfaTotpState struct {
// `(string)` - Specifies the hashing algorithm used to generate the TOTP code.
// Options include `SHA1`, `SHA256` and `SHA512`
Algorithm pulumi.StringPtrInput
// `(int)` - The number of digits in the generated TOTP token.
// This value can either be 6 or 8.
Digits pulumi.IntPtrInput
// `(string: <required>)` - The name of the key's issuing organization.
Issuer pulumi.StringPtrInput
// `(int)` - Specifies the size in bytes of the generated key.
KeySize pulumi.IntPtrInput
// `(string: <required>)` – Name of the MFA method.
Name pulumi.StringPtrInput
// The namespace to provision the resource in.
// The value should not contain leading or trailing forward slashes.
// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
// *Available only for Vault Enterprise*.
Namespace pulumi.StringPtrInput
// `(int)` - The length of time used to generate a counter for the TOTP token calculation.
Period pulumi.IntPtrInput
// `(int)` - The pixel size of the generated square QR code.
QrSize pulumi.IntPtrInput
// `(int)` - The number of delay periods that are allowed when validating a TOTP token.
// This value can either be 0 or 1.
Skew pulumi.IntPtrInput
}
func (MfaTotpState) ElementType() reflect.Type {
return reflect.TypeOf((*mfaTotpState)(nil)).Elem()
}
type mfaTotpArgs struct {
// `(string)` - Specifies the hashing algorithm used to generate the TOTP code.
// Options include `SHA1`, `SHA256` and `SHA512`
Algorithm *string `pulumi:"algorithm"`
// `(int)` - The number of digits in the generated TOTP token.
// This value can either be 6 or 8.
Digits *int `pulumi:"digits"`
// `(string: <required>)` - The name of the key's issuing organization.
Issuer string `pulumi:"issuer"`
// `(int)` - Specifies the size in bytes of the generated key.
KeySize *int `pulumi:"keySize"`
// `(string: <required>)` – Name of the MFA method.
Name *string `pulumi:"name"`
// The namespace to provision the resource in.
// The value should not contain leading or trailing forward slashes.
// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
// *Available only for Vault Enterprise*.
Namespace *string `pulumi:"namespace"`
// `(int)` - The length of time used to generate a counter for the TOTP token calculation.
Period *int `pulumi:"period"`
// `(int)` - The pixel size of the generated square QR code.
QrSize *int `pulumi:"qrSize"`
// `(int)` - The number of delay periods that are allowed when validating a TOTP token.
// This value can either be 0 or 1.
Skew *int `pulumi:"skew"`
}
// The set of arguments for constructing a MfaTotp resource.
type MfaTotpArgs struct {
// `(string)` - Specifies the hashing algorithm used to generate the TOTP code.
// Options include `SHA1`, `SHA256` and `SHA512`
Algorithm pulumi.StringPtrInput
// `(int)` - The number of digits in the generated TOTP token.
// This value can either be 6 or 8.
Digits pulumi.IntPtrInput
// `(string: <required>)` - The name of the key's issuing organization.
Issuer pulumi.StringInput
// `(int)` - Specifies the size in bytes of the generated key.
KeySize pulumi.IntPtrInput
// `(string: <required>)` – Name of the MFA method.
Name pulumi.StringPtrInput
// The namespace to provision the resource in.
// The value should not contain leading or trailing forward slashes.
// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
// *Available only for Vault Enterprise*.
Namespace pulumi.StringPtrInput
// `(int)` - The length of time used to generate a counter for the TOTP token calculation.
Period pulumi.IntPtrInput
// `(int)` - The pixel size of the generated square QR code.
QrSize pulumi.IntPtrInput
// `(int)` - The number of delay periods that are allowed when validating a TOTP token.
// This value can either be 0 or 1.
Skew pulumi.IntPtrInput
}
func (MfaTotpArgs) ElementType() reflect.Type {
return reflect.TypeOf((*mfaTotpArgs)(nil)).Elem()
}
type MfaTotpInput interface {
pulumi.Input
ToMfaTotpOutput() MfaTotpOutput
ToMfaTotpOutputWithContext(ctx context.Context) MfaTotpOutput
}
func (*MfaTotp) ElementType() reflect.Type {
return reflect.TypeOf((**MfaTotp)(nil)).Elem()
}
func (i *MfaTotp) ToMfaTotpOutput() MfaTotpOutput {
return i.ToMfaTotpOutputWithContext(context.Background())
}
func (i *MfaTotp) ToMfaTotpOutputWithContext(ctx context.Context) MfaTotpOutput {
return pulumi.ToOutputWithContext(ctx, i).(MfaTotpOutput)
}
// MfaTotpArrayInput is an input type that accepts MfaTotpArray and MfaTotpArrayOutput values.
// You can construct a concrete instance of `MfaTotpArrayInput` via:
//
// MfaTotpArray{ MfaTotpArgs{...} }
type MfaTotpArrayInput interface {
pulumi.Input
ToMfaTotpArrayOutput() MfaTotpArrayOutput
ToMfaTotpArrayOutputWithContext(context.Context) MfaTotpArrayOutput
}
type MfaTotpArray []MfaTotpInput
func (MfaTotpArray) ElementType() reflect.Type {
return reflect.TypeOf((*[]*MfaTotp)(nil)).Elem()
}
func (i MfaTotpArray) ToMfaTotpArrayOutput() MfaTotpArrayOutput {
return i.ToMfaTotpArrayOutputWithContext(context.Background())
}
func (i MfaTotpArray) ToMfaTotpArrayOutputWithContext(ctx context.Context) MfaTotpArrayOutput {
return pulumi.ToOutputWithContext(ctx, i).(MfaTotpArrayOutput)
}
// MfaTotpMapInput is an input type that accepts MfaTotpMap and MfaTotpMapOutput values.
// You can construct a concrete instance of `MfaTotpMapInput` via:
//
// MfaTotpMap{ "key": MfaTotpArgs{...} }
type MfaTotpMapInput interface {
pulumi.Input
ToMfaTotpMapOutput() MfaTotpMapOutput
ToMfaTotpMapOutputWithContext(context.Context) MfaTotpMapOutput
}
type MfaTotpMap map[string]MfaTotpInput
func (MfaTotpMap) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*MfaTotp)(nil)).Elem()
}
func (i MfaTotpMap) ToMfaTotpMapOutput() MfaTotpMapOutput {
return i.ToMfaTotpMapOutputWithContext(context.Background())
}
func (i MfaTotpMap) ToMfaTotpMapOutputWithContext(ctx context.Context) MfaTotpMapOutput {
return pulumi.ToOutputWithContext(ctx, i).(MfaTotpMapOutput)
}
type MfaTotpOutput struct{ *pulumi.OutputState }
func (MfaTotpOutput) ElementType() reflect.Type {
return reflect.TypeOf((**MfaTotp)(nil)).Elem()
}
func (o MfaTotpOutput) ToMfaTotpOutput() MfaTotpOutput {
return o
}
func (o MfaTotpOutput) ToMfaTotpOutputWithContext(ctx context.Context) MfaTotpOutput {
return o
}
// `(string)` - Specifies the hashing algorithm used to generate the TOTP code.
// Options include `SHA1`, `SHA256` and `SHA512`
func (o MfaTotpOutput) Algorithm() pulumi.StringPtrOutput {
return o.ApplyT(func(v *MfaTotp) pulumi.StringPtrOutput { return v.Algorithm }).(pulumi.StringPtrOutput)
}
// `(int)` - The number of digits in the generated TOTP token.
// This value can either be 6 or 8.
func (o MfaTotpOutput) Digits() pulumi.IntPtrOutput {
return o.ApplyT(func(v *MfaTotp) pulumi.IntPtrOutput { return v.Digits }).(pulumi.IntPtrOutput)
}
// `(string: <required>)` - The name of the key's issuing organization.
func (o MfaTotpOutput) Issuer() pulumi.StringOutput {
return o.ApplyT(func(v *MfaTotp) pulumi.StringOutput { return v.Issuer }).(pulumi.StringOutput)
}
// `(int)` - Specifies the size in bytes of the generated key.
func (o MfaTotpOutput) KeySize() pulumi.IntPtrOutput {
return o.ApplyT(func(v *MfaTotp) pulumi.IntPtrOutput { return v.KeySize }).(pulumi.IntPtrOutput)
}
// `(string: <required>)` – Name of the MFA method.
func (o MfaTotpOutput) Name() pulumi.StringOutput {
return o.ApplyT(func(v *MfaTotp) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}
// The namespace to provision the resource in.
// The value should not contain leading or trailing forward slashes.
// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
// *Available only for Vault Enterprise*.
func (o MfaTotpOutput) Namespace() pulumi.StringPtrOutput {
return o.ApplyT(func(v *MfaTotp) pulumi.StringPtrOutput { return v.Namespace }).(pulumi.StringPtrOutput)
}
// `(int)` - The length of time used to generate a counter for the TOTP token calculation.
func (o MfaTotpOutput) Period() pulumi.IntPtrOutput {
return o.ApplyT(func(v *MfaTotp) pulumi.IntPtrOutput { return v.Period }).(pulumi.IntPtrOutput)
}
// `(int)` - The pixel size of the generated square QR code.
func (o MfaTotpOutput) QrSize() pulumi.IntPtrOutput {
return o.ApplyT(func(v *MfaTotp) pulumi.IntPtrOutput { return v.QrSize }).(pulumi.IntPtrOutput)
}
// `(int)` - The number of delay periods that are allowed when validating a TOTP token.
// This value can either be 0 or 1.
func (o MfaTotpOutput) Skew() pulumi.IntPtrOutput {
return o.ApplyT(func(v *MfaTotp) pulumi.IntPtrOutput { return v.Skew }).(pulumi.IntPtrOutput)
}
type MfaTotpArrayOutput struct{ *pulumi.OutputState }
func (MfaTotpArrayOutput) ElementType() reflect.Type {
return reflect.TypeOf((*[]*MfaTotp)(nil)).Elem()
}
func (o MfaTotpArrayOutput) ToMfaTotpArrayOutput() MfaTotpArrayOutput {
return o
}
func (o MfaTotpArrayOutput) ToMfaTotpArrayOutputWithContext(ctx context.Context) MfaTotpArrayOutput {
return o
}
func (o MfaTotpArrayOutput) Index(i pulumi.IntInput) MfaTotpOutput {
return pulumi.All(o, i).ApplyT(func(vs []interface{}) *MfaTotp {
return vs[0].([]*MfaTotp)[vs[1].(int)]
}).(MfaTotpOutput)
}
type MfaTotpMapOutput struct{ *pulumi.OutputState }
func (MfaTotpMapOutput) ElementType() reflect.Type {
return reflect.TypeOf((*map[string]*MfaTotp)(nil)).Elem()
}
func (o MfaTotpMapOutput) ToMfaTotpMapOutput() MfaTotpMapOutput {
return o
}
func (o MfaTotpMapOutput) ToMfaTotpMapOutputWithContext(ctx context.Context) MfaTotpMapOutput {
return o
}
func (o MfaTotpMapOutput) MapIndex(k pulumi.StringInput) MfaTotpOutput {
return pulumi.All(o, k).ApplyT(func(vs []interface{}) *MfaTotp {
return vs[0].(map[string]*MfaTotp)[vs[1].(string)]
}).(MfaTotpOutput)
}
func init() {
pulumi.RegisterInputType(reflect.TypeOf((*MfaTotpInput)(nil)).Elem(), &MfaTotp{})
pulumi.RegisterInputType(reflect.TypeOf((*MfaTotpArrayInput)(nil)).Elem(), MfaTotpArray{})
pulumi.RegisterInputType(reflect.TypeOf((*MfaTotpMapInput)(nil)).Elem(), MfaTotpMap{})
pulumi.RegisterOutputType(MfaTotpOutput{})
pulumi.RegisterOutputType(MfaTotpArrayOutput{})
pulumi.RegisterOutputType(MfaTotpMapOutput{})
}