Skip to content

Commit bc31a1a

Browse files
committed
fixing markdown titles to work with github parsing
1 parent e90d9a4 commit bc31a1a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -14,29 +14,29 @@ This client is a fully compliant, native Python implementation of the [AWS Encry
1414
$ pip install aws-encryption-sdk
1515
```
1616

17-
##Concepts
17+
## Concepts
1818
There are three main concepts that need to be understood for use of this library:
1919

20-
###Master Key Providers
20+
### Master Key Providers
2121
Master Key Providers are resources which provide Master Keys.
2222
An example of a Master Key Provider is [AWS KMS][2].
2323

2424
In the context of this client, a MasterKeyProvider object must contain at least one MasterKey object in order to encrypt data.
2525

2626
MasterKeyProvider objects can also contain other MasterKeyProviders.
2727

28-
###Master Keys
28+
### Master Keys
2929
Master Keys provide data keys.
3030
An example of a Master Key is a [KMS Customer Master Key][3].
3131

32-
###Data Keys
32+
### Data Keys
3333
Data Keys are the actual encryption keys which are used to encrypt your data.
3434

35-
#Usage
35+
# Usage
3636
In order to use this client, an instance of a Master Key Provider must be provided.
3737
For the examples in this readme, the KMSMasterKeyProvider class will be used as an example.
3838

39-
##KMSMasterKeyProvider
39+
## KMSMasterKeyProvider
4040
The KMSMasterKeyProvider uses the [boto3 SDK][4] to interact with [AWS KMS][2], and as such requires AWS Credentials.
4141
These can be provided either in the [standard means by which boto3 locates credentials][5], or by providing the KMSMasterKeyProvider a pre-existing instance of a botocore session.
4242
This later option can be useful if you have some alternate means of storing your AWS credentials or
@@ -78,7 +78,7 @@ kms_key_provider = aws_encryption_sdk.KMSMasterKeyProvider(key_ids=[
7878
```
7979

8080

81-
##Encryption and Decryption
81+
## Encryption and Decryption
8282
Once you have an instance of a MasterKeyProvider, you can simply use one of the two high-level encrypt/decrypt functions to encrypt and decrypt your data.
8383

8484
```python
@@ -133,7 +133,7 @@ assert my_plaintext == decrypted_plaintext
133133
assert encryptor_header.encryption_context == decryptor_header.encryption_context
134134
```
135135

136-
##Streaming
136+
## Streaming
137137
If you are handling large files or simply do not want to put the entire plaintext or ciphertext in memory at once, this library also provides streaming clients.
138138
The streaming clients are file-like objects, and behave exactly as you would expect a Python file object to behave, supporting context managers and iteration.
139139
Rather than accepting a string as input, the streaming clients expect an existing file-like object.
@@ -175,7 +175,7 @@ assert filecmp.cmp(plaintext_filename, new_plaintext_filename)
175175
assert encryptor.header.encryption_context == decryptor.header.encryption_context
176176
```
177177

178-
##Performance Considerations
178+
## Performance Considerations
179179
Two things will significantly improve the performance of encrypt/decrypt operations with this library:
180180

181181
1. The line length (chunk size) (default: 8192 bytes).

0 commit comments

Comments
 (0)