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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
|
%global _empty_manifest_terminate_build 0
Name: python-cdk-ec2-key-pair
Version: 3.3.1
Release: 1
Summary: CDK Construct for managing EC2 key pairs
License: Apache-2.0
URL: https://github.com/udondan/cdk-ec2-key-pair
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/5f/50/613824e91e39527360b77675a045b90cc0a07a6cf323d55672cdff20277a/cdk-ec2-key-pair-3.3.1.tar.gz
BuildArch: noarch
Requires: python3-aws-cdk-lib
Requires: python3-constructs
Requires: python3-jsii
Requires: python3-publication
%description
# CDK EC2 Key Pair
[](https://github.com/udondan/cdk-ec2-key-pair)
[](https://github.com/udondan/cdk-ec2-key-pair/actions?query=workflow%3ATest)
[](https://github.com/udondan/cdk-ec2-key-pair/blob/master/LICENSE)
[](https://constructs.dev/packages/cdk-ec2-key-pair)
[](https://www.npmjs.com/package/cdk-ec2-key-pair)
[](https://pypi.org/project/cdk-ec2-key-pair/)
[](https://www.npmjs.com/package/cdk-ec2-key-pair)
[](https://pypi.org/project/cdk-ec2-key-pair/)
[AWS CDK](https://aws.amazon.com/cdk/) L3 construct for managing [EC2 Key Pairs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html).
CloudFormation doesn't directly support creation of EC2 Key Pairs. This construct provides an easy interface for creating Key Pairs through a [custom CloudFormation resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html). The private key is stored in [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/).
## Installation
This package has peer dependencies, which need to be installed along in the expected version.
For TypeScript/NodeJS, add these to your `dependencies` in `package.json`. For Python, add these to your `requirements.txt`:
* cdk-ec2-key-pair
* aws-cdk-lib (^2.0.0)
* constructs (^10.0.0)
## CDK compatibility
* Version 3.x is compatible with the CDK v2.
* Version 2.x is compatible with the CDK v1. There won't be regular updates for this.
## Usage
```python
import cdk = require('aws-cdk-lib');
import { Construct } from 'constructs';
import { KeyPair } from 'cdk-ec2-key-pair';
// ...
// Create the Key Pair
const key = new KeyPair(this, 'A-Key-Pair', {
name: 'a-key-pair',
description: 'This is a Key Pair',
storePublicKey: true, // by default the public key will not be stored in Secrets Manager
});
// Grant read access to the private key to a role or user
key.grantReadOnPrivateKey(someRole)
// Grant read access to the public key to another role or user
key.grantReadOnPublicKey(anotherRole)
// Use Key Pair on an EC2 instance
new ec2.Instance(this, 'An-Instance', {
keyName: key.keyPairName,
// ...
})
```
The private (and optionally the public) key will be stored in AWS Secrets Manager. The secret names by default are prefixed with `ec2-ssh-key/`. The private key is suffixed with `/private`, the public key is suffixed with `/public`. So in this example they will be stored as `ec2-ssh-key/a-key-pair/private` and `ec2-ssh-key/a-key-pair/public`.
To download the private key via AWS cli you can run:
```bash
aws secretsmanager get-secret-value \
--secret-id ec2-ssh-key/a-key-pair/private \
--query SecretString \
--output text
```
### Tag support
The construct supports tagging:
```python
cdk.Tags.of(key).add('someTag', 'some value');
```
We also use tags to restrict update/delete actions to those, the construct created itself. The Lambda function, which backs the custom CFN resource, is not able to manipulate other keys/secrets. The tag we use for identifying these resources is `CreatedByCfnCustomResource` with value `CFN::Resource::Custom::EC2-Key-Pair`.
### Updates
Since an EC2 KeyPair cannot be updated, you cannot change any property related to the KeyPair. The code has checks in place which will prevent any attempt to do so. If you try, the stack will end in a failed state. In that case you can safely continue the rollback in the AWS console and ignore the key resource.
You can, however, change properties that only relate to the secrets. These are the KMS keys used for encryption, the `secretPrefix`, `description` and `removeKeySecretsAfterDays`.
### Encryption
Secrets in the AWS Secrets Manager by default are encrypted with the key `alias/aws/secretsmanager`.
To use a custom KMS key you can pass it to the Key Pair:
```python
const kmsKey = new kms.Key(this, 'KMS-key');
const keyPair = new KeyPair(this, 'A-Key-Pair', {
name: 'a-key-pair',
kms: kmsKey,
});
```
This KMS key needs to be created in the same stack. You cannot use a key imported via ARN, because the keys access policy will need to be modified.
To use different KMS keys for the private and public key, use the `kmsPrivateKey` and `kmsPublicKey` instead:
```python
const kmsKeyPrivate = new kms.Key(this, 'KMS-key-private');
const kmsKeyPublic = new kms.Key(this, 'KMS-key-public');
const keyPair = new KeyPair(this, 'A-Key-Pair', {
name: 'a-key-pair',
kmsPrivateKey: kmsKeyPrivate,
kmsPublicKey: kmsKeyPublic
});
```
### Importing public key
You can create a key pair by importing the public key. Obviously, in this case the private key won't be available in secrets manager.
The public key has to be in OpenSSH format.
```python
new KeyPair(this, 'Test-Key-Pair', {
name: 'imported-key-pair',
publicKey: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCuMmbK...'
});
```
### Using the key pair for CloudFront signed url/cookies
You can use this library for generating keys for CloudFront signed url/cookies.
Make sure to set `publicKeyFormat` to `PublicKeyFormat.PEM` as that is the format required for CloudFront.
You also have to set `exposePublicKey` to `true` so you can actually get the public key.
```python
const key = new KeyPair(this, 'Signing-Key-Pair', {
name: 'CFN-signing-key',
exposePublicKey: true,
storePublicKey: true,
publicKeyFormat: PublicKeyFormat.PEM
});
const pubKey = new cloudfront.PublicKey(this, 'Signing-Public-Key', {
encodedKey: key.publicKeyValue,
});
const trustedKeyGroupForCF = new cloudfront.KeyGroup(this, 'Signing-Key-Group', {
items: [ pubKey ]
});
```
%package -n python3-cdk-ec2-key-pair
Summary: CDK Construct for managing EC2 key pairs
Provides: python-cdk-ec2-key-pair
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-cdk-ec2-key-pair
# CDK EC2 Key Pair
[](https://github.com/udondan/cdk-ec2-key-pair)
[](https://github.com/udondan/cdk-ec2-key-pair/actions?query=workflow%3ATest)
[](https://github.com/udondan/cdk-ec2-key-pair/blob/master/LICENSE)
[](https://constructs.dev/packages/cdk-ec2-key-pair)
[](https://www.npmjs.com/package/cdk-ec2-key-pair)
[](https://pypi.org/project/cdk-ec2-key-pair/)
[](https://www.npmjs.com/package/cdk-ec2-key-pair)
[](https://pypi.org/project/cdk-ec2-key-pair/)
[AWS CDK](https://aws.amazon.com/cdk/) L3 construct for managing [EC2 Key Pairs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html).
CloudFormation doesn't directly support creation of EC2 Key Pairs. This construct provides an easy interface for creating Key Pairs through a [custom CloudFormation resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html). The private key is stored in [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/).
## Installation
This package has peer dependencies, which need to be installed along in the expected version.
For TypeScript/NodeJS, add these to your `dependencies` in `package.json`. For Python, add these to your `requirements.txt`:
* cdk-ec2-key-pair
* aws-cdk-lib (^2.0.0)
* constructs (^10.0.0)
## CDK compatibility
* Version 3.x is compatible with the CDK v2.
* Version 2.x is compatible with the CDK v1. There won't be regular updates for this.
## Usage
```python
import cdk = require('aws-cdk-lib');
import { Construct } from 'constructs';
import { KeyPair } from 'cdk-ec2-key-pair';
// ...
// Create the Key Pair
const key = new KeyPair(this, 'A-Key-Pair', {
name: 'a-key-pair',
description: 'This is a Key Pair',
storePublicKey: true, // by default the public key will not be stored in Secrets Manager
});
// Grant read access to the private key to a role or user
key.grantReadOnPrivateKey(someRole)
// Grant read access to the public key to another role or user
key.grantReadOnPublicKey(anotherRole)
// Use Key Pair on an EC2 instance
new ec2.Instance(this, 'An-Instance', {
keyName: key.keyPairName,
// ...
})
```
The private (and optionally the public) key will be stored in AWS Secrets Manager. The secret names by default are prefixed with `ec2-ssh-key/`. The private key is suffixed with `/private`, the public key is suffixed with `/public`. So in this example they will be stored as `ec2-ssh-key/a-key-pair/private` and `ec2-ssh-key/a-key-pair/public`.
To download the private key via AWS cli you can run:
```bash
aws secretsmanager get-secret-value \
--secret-id ec2-ssh-key/a-key-pair/private \
--query SecretString \
--output text
```
### Tag support
The construct supports tagging:
```python
cdk.Tags.of(key).add('someTag', 'some value');
```
We also use tags to restrict update/delete actions to those, the construct created itself. The Lambda function, which backs the custom CFN resource, is not able to manipulate other keys/secrets. The tag we use for identifying these resources is `CreatedByCfnCustomResource` with value `CFN::Resource::Custom::EC2-Key-Pair`.
### Updates
Since an EC2 KeyPair cannot be updated, you cannot change any property related to the KeyPair. The code has checks in place which will prevent any attempt to do so. If you try, the stack will end in a failed state. In that case you can safely continue the rollback in the AWS console and ignore the key resource.
You can, however, change properties that only relate to the secrets. These are the KMS keys used for encryption, the `secretPrefix`, `description` and `removeKeySecretsAfterDays`.
### Encryption
Secrets in the AWS Secrets Manager by default are encrypted with the key `alias/aws/secretsmanager`.
To use a custom KMS key you can pass it to the Key Pair:
```python
const kmsKey = new kms.Key(this, 'KMS-key');
const keyPair = new KeyPair(this, 'A-Key-Pair', {
name: 'a-key-pair',
kms: kmsKey,
});
```
This KMS key needs to be created in the same stack. You cannot use a key imported via ARN, because the keys access policy will need to be modified.
To use different KMS keys for the private and public key, use the `kmsPrivateKey` and `kmsPublicKey` instead:
```python
const kmsKeyPrivate = new kms.Key(this, 'KMS-key-private');
const kmsKeyPublic = new kms.Key(this, 'KMS-key-public');
const keyPair = new KeyPair(this, 'A-Key-Pair', {
name: 'a-key-pair',
kmsPrivateKey: kmsKeyPrivate,
kmsPublicKey: kmsKeyPublic
});
```
### Importing public key
You can create a key pair by importing the public key. Obviously, in this case the private key won't be available in secrets manager.
The public key has to be in OpenSSH format.
```python
new KeyPair(this, 'Test-Key-Pair', {
name: 'imported-key-pair',
publicKey: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCuMmbK...'
});
```
### Using the key pair for CloudFront signed url/cookies
You can use this library for generating keys for CloudFront signed url/cookies.
Make sure to set `publicKeyFormat` to `PublicKeyFormat.PEM` as that is the format required for CloudFront.
You also have to set `exposePublicKey` to `true` so you can actually get the public key.
```python
const key = new KeyPair(this, 'Signing-Key-Pair', {
name: 'CFN-signing-key',
exposePublicKey: true,
storePublicKey: true,
publicKeyFormat: PublicKeyFormat.PEM
});
const pubKey = new cloudfront.PublicKey(this, 'Signing-Public-Key', {
encodedKey: key.publicKeyValue,
});
const trustedKeyGroupForCF = new cloudfront.KeyGroup(this, 'Signing-Key-Group', {
items: [ pubKey ]
});
```
%package help
Summary: Development documents and examples for cdk-ec2-key-pair
Provides: python3-cdk-ec2-key-pair-doc
%description help
# CDK EC2 Key Pair
[](https://github.com/udondan/cdk-ec2-key-pair)
[](https://github.com/udondan/cdk-ec2-key-pair/actions?query=workflow%3ATest)
[](https://github.com/udondan/cdk-ec2-key-pair/blob/master/LICENSE)
[](https://constructs.dev/packages/cdk-ec2-key-pair)
[](https://www.npmjs.com/package/cdk-ec2-key-pair)
[](https://pypi.org/project/cdk-ec2-key-pair/)
[](https://www.npmjs.com/package/cdk-ec2-key-pair)
[](https://pypi.org/project/cdk-ec2-key-pair/)
[AWS CDK](https://aws.amazon.com/cdk/) L3 construct for managing [EC2 Key Pairs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html).
CloudFormation doesn't directly support creation of EC2 Key Pairs. This construct provides an easy interface for creating Key Pairs through a [custom CloudFormation resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html). The private key is stored in [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/).
## Installation
This package has peer dependencies, which need to be installed along in the expected version.
For TypeScript/NodeJS, add these to your `dependencies` in `package.json`. For Python, add these to your `requirements.txt`:
* cdk-ec2-key-pair
* aws-cdk-lib (^2.0.0)
* constructs (^10.0.0)
## CDK compatibility
* Version 3.x is compatible with the CDK v2.
* Version 2.x is compatible with the CDK v1. There won't be regular updates for this.
## Usage
```python
import cdk = require('aws-cdk-lib');
import { Construct } from 'constructs';
import { KeyPair } from 'cdk-ec2-key-pair';
// ...
// Create the Key Pair
const key = new KeyPair(this, 'A-Key-Pair', {
name: 'a-key-pair',
description: 'This is a Key Pair',
storePublicKey: true, // by default the public key will not be stored in Secrets Manager
});
// Grant read access to the private key to a role or user
key.grantReadOnPrivateKey(someRole)
// Grant read access to the public key to another role or user
key.grantReadOnPublicKey(anotherRole)
// Use Key Pair on an EC2 instance
new ec2.Instance(this, 'An-Instance', {
keyName: key.keyPairName,
// ...
})
```
The private (and optionally the public) key will be stored in AWS Secrets Manager. The secret names by default are prefixed with `ec2-ssh-key/`. The private key is suffixed with `/private`, the public key is suffixed with `/public`. So in this example they will be stored as `ec2-ssh-key/a-key-pair/private` and `ec2-ssh-key/a-key-pair/public`.
To download the private key via AWS cli you can run:
```bash
aws secretsmanager get-secret-value \
--secret-id ec2-ssh-key/a-key-pair/private \
--query SecretString \
--output text
```
### Tag support
The construct supports tagging:
```python
cdk.Tags.of(key).add('someTag', 'some value');
```
We also use tags to restrict update/delete actions to those, the construct created itself. The Lambda function, which backs the custom CFN resource, is not able to manipulate other keys/secrets. The tag we use for identifying these resources is `CreatedByCfnCustomResource` with value `CFN::Resource::Custom::EC2-Key-Pair`.
### Updates
Since an EC2 KeyPair cannot be updated, you cannot change any property related to the KeyPair. The code has checks in place which will prevent any attempt to do so. If you try, the stack will end in a failed state. In that case you can safely continue the rollback in the AWS console and ignore the key resource.
You can, however, change properties that only relate to the secrets. These are the KMS keys used for encryption, the `secretPrefix`, `description` and `removeKeySecretsAfterDays`.
### Encryption
Secrets in the AWS Secrets Manager by default are encrypted with the key `alias/aws/secretsmanager`.
To use a custom KMS key you can pass it to the Key Pair:
```python
const kmsKey = new kms.Key(this, 'KMS-key');
const keyPair = new KeyPair(this, 'A-Key-Pair', {
name: 'a-key-pair',
kms: kmsKey,
});
```
This KMS key needs to be created in the same stack. You cannot use a key imported via ARN, because the keys access policy will need to be modified.
To use different KMS keys for the private and public key, use the `kmsPrivateKey` and `kmsPublicKey` instead:
```python
const kmsKeyPrivate = new kms.Key(this, 'KMS-key-private');
const kmsKeyPublic = new kms.Key(this, 'KMS-key-public');
const keyPair = new KeyPair(this, 'A-Key-Pair', {
name: 'a-key-pair',
kmsPrivateKey: kmsKeyPrivate,
kmsPublicKey: kmsKeyPublic
});
```
### Importing public key
You can create a key pair by importing the public key. Obviously, in this case the private key won't be available in secrets manager.
The public key has to be in OpenSSH format.
```python
new KeyPair(this, 'Test-Key-Pair', {
name: 'imported-key-pair',
publicKey: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCuMmbK...'
});
```
### Using the key pair for CloudFront signed url/cookies
You can use this library for generating keys for CloudFront signed url/cookies.
Make sure to set `publicKeyFormat` to `PublicKeyFormat.PEM` as that is the format required for CloudFront.
You also have to set `exposePublicKey` to `true` so you can actually get the public key.
```python
const key = new KeyPair(this, 'Signing-Key-Pair', {
name: 'CFN-signing-key',
exposePublicKey: true,
storePublicKey: true,
publicKeyFormat: PublicKeyFormat.PEM
});
const pubKey = new cloudfront.PublicKey(this, 'Signing-Public-Key', {
encodedKey: key.publicKeyValue,
});
const trustedKeyGroupForCF = new cloudfront.KeyGroup(this, 'Signing-Key-Group', {
items: [ pubKey ]
});
```
%prep
%autosetup -n cdk-ec2-key-pair-3.3.1
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-cdk-ec2-key-pair -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 3.3.1-1
- Package Spec generated
|
