README.md in s3-secure-0.4.0 vs README.md in s3-secure-0.4.1
- old
+ new
@@ -23,9 +23,103 @@
s3-secure policy list
s3-secure policy show BUCKET
s3-secure policy enforce_ssl BUCKET
s3-secure policy unforce_ssl BUCKET
+## Examples with Output
+
+Example of `s3-secure encryption enable`:
+
+ $ s3-secure encryption enable a-test-bucket-in-us-west-1
+ Encyption enabled on bucket a-test-bucket-in-us-west-1 with rules:
+ {:apply_server_side_encryption_by_default=>{:sse_algorithm=>"AES256"}}
+ $
+
+Example of `s3-secure policy enforce_ssl`:
+
+ $ s3-secure policy enforce_ssl a-test-bucket-in-us-west-1
+ Add bucket policy to bucket a-test-bucket-in-us-west-1:
+ {
+ "Version": "2012-10-17",
+ "Statement": [
+ {
+ "Sid": "ForceSSLOnlyAccess",
+ "Effect": "Deny",
+ "Principal": "*",
+ "Action": "s3:GetObject",
+ "Resource": "arn:aws:s3:::a-test-bucket-in-us-west-1/*",
+ "Condition": {
+ "Bool": {
+ "aws:SecureTransport": "false"
+ }
+ }
+ }
+ ]
+ }
+ $
+
+When removing ssl enforcement from the bucket policy, if there are other policy statements, those are left in tact. Example:
+
+ $ s3-secure policy show a-test-bucket-in-us-east-1
+ Bucket a-test-bucket-in-us-east-1 is configured with this policy:
+ {
+ "Version": "2012-10-17",
+ "Statement": [
+ {
+ "Sid": "IPAllow",
+ "Effect": "Deny",
+ "Principal": "*",
+ "Action": "s3:*",
+ "Resource": "arn:aws:s3:::a-test-bucket-in-us-east-1/*",
+ "Condition": {
+ "NotIpAddress": {
+ "aws:SourceIp": "54.240.143.0/24"
+ }
+ }
+ },
+ {
+ "Sid": "ForceSSLOnlyAccess",
+ "Effect": "Deny",
+ "Principal": "*",
+ "Action": "s3:GetObject",
+ "Resource": "arn:aws:s3:::a-test-bucket-in-us-east-1/*",
+ "Condition": {
+ "Bool": {
+ "aws:SecureTransport": "false"
+ }
+ }
+ }
+ ]
+ }
+ $ s3-secure policy unforce_ssl a-test-bucket-in-us-east-1
+ Remove bucket policy statement from bucket a-test-bucket-in-us-east-1:
+ {
+ "Version": "2012-10-17",
+ "Statement": [
+ {
+ "Sid": "IPAllow",
+ "Effect": "Deny",
+ "Principal": "*",
+ "Action": "s3:*",
+ "Resource": "arn:aws:s3:::a-test-bucket-in-us-east-1/*",
+ "Condition": {
+ "NotIpAddress": {
+ "aws:SourceIp": "54.240.143.0/24"
+ }
+ }
+ }
+ ]
+ }
+ $
+
+For more help:
+
+ s3-secure -h
+ s3-secure encryption -h
+ s3-secure encryption enable -h
+ s3-secure policy -h
+ s3-secure policy unforce_ssl -h
+
## Batch Commands
There are some supported batch commands:
s3-secure batch encryption enable FILE.txt