2017-11-07 18:18:59 -05:00
/ *
2018-02-23 18:07:21 -05:00
* Minio Cloud Storage , ( C ) 2017 , 2018 Minio , Inc .
2017-11-07 18:18:59 -05:00
*
* Licensed under the Apache License , Version 2.0 ( the "License" ) ;
* you may not use this file except in compliance with the License .
* You may obtain a copy of the License at
*
* http : //www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing , software
* distributed under the License is distributed on an "AS IS" BASIS ,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND , either express or implied .
* See the License for the specific language governing permissions and
* limitations under the License .
* /
package cmd
import (
"bytes"
2018-03-01 14:37:57 -05:00
"crypto/hmac"
2017-11-07 18:18:59 -05:00
"crypto/md5"
"crypto/rand"
2018-02-23 18:07:21 -05:00
"crypto/subtle"
2017-11-07 18:18:59 -05:00
"encoding/base64"
2018-03-01 14:37:57 -05:00
"encoding/binary"
2017-11-07 18:18:59 -05:00
"errors"
"io"
"net/http"
2018-03-02 20:24:02 -05:00
"github.com/minio/minio/pkg/ioutil"
2017-11-07 18:18:59 -05:00
sha256 "github.com/minio/sha256-simd"
"github.com/minio/sio"
)
var (
// AWS errors for invalid SSE-C requests.
errInsecureSSERequest = errors . New ( "Requests specifying Server Side Encryption with Customer provided keys must be made over a secure connection" )
errEncryptedObject = errors . New ( "The object was stored using a form of Server Side Encryption. The correct parameters must be provided to retrieve the object" )
errInvalidSSEAlgorithm = errors . New ( "Requests specifying Server Side Encryption with Customer provided keys must provide a valid encryption algorithm" )
errMissingSSEKey = errors . New ( "Requests specifying Server Side Encryption with Customer provided keys must provide an appropriate secret key" )
errInvalidSSEKey = errors . New ( "The secret key was invalid for the specified algorithm" )
errMissingSSEKeyMD5 = errors . New ( "Requests specifying Server Side Encryption with Customer provided keys must provide the client calculated MD5 of the secret key" )
errSSEKeyMD5Mismatch = errors . New ( "The calculated MD5 hash of the key did not match the hash that was provided" )
errSSEKeyMismatch = errors . New ( "The client provided key does not match the key provided when the object was encrypted" ) // this msg is not shown to the client
// Additional Minio errors for SSE-C requests.
errObjectTampered = errors . New ( "The requested object was modified and may be compromised" )
)
const (
// SSECustomerAlgorithm is the AWS SSE-C algorithm HTTP header key.
SSECustomerAlgorithm = "X-Amz-Server-Side-Encryption-Customer-Algorithm"
// SSECustomerKey is the AWS SSE-C encryption key HTTP header key.
SSECustomerKey = "X-Amz-Server-Side-Encryption-Customer-Key"
// SSECustomerKeyMD5 is the AWS SSE-C encryption key MD5 HTTP header key.
SSECustomerKeyMD5 = "X-Amz-Server-Side-Encryption-Customer-Key-MD5"
2018-02-23 18:07:21 -05:00
// SSECopyCustomerAlgorithm is the AWS SSE-C algorithm HTTP header key for CopyObject API.
SSECopyCustomerAlgorithm = "X-Amz-Copy-Source-Server-Side-Encryption-Customer-Algorithm"
// SSECopyCustomerKey is the AWS SSE-C encryption key HTTP header key for CopyObject API.
SSECopyCustomerKey = "X-Amz-Copy-Source-Server-Side-Encryption-Customer-Key"
// SSECopyCustomerKeyMD5 is the AWS SSE-C encryption key MD5 HTTP header key for CopyObject API.
SSECopyCustomerKeyMD5 = "X-Amz-Copy-Source-Server-Side-Encryption-Customer-Key-MD5"
2017-11-07 18:18:59 -05:00
)
const (
// SSECustomerKeySize is the size of valid client provided encryption keys in bytes.
// Currently AWS supports only AES256. So the SSE-C key size is fixed to 32 bytes.
SSECustomerKeySize = 32
2018-03-01 14:37:57 -05:00
// SSEIVSize is the size of the IV data
SSEIVSize = 32 // 32 bytes
2017-11-07 18:18:59 -05:00
// SSECustomerAlgorithmAES256 the only valid S3 SSE-C encryption algorithm identifier.
SSECustomerAlgorithmAES256 = "AES256"
2018-03-01 14:37:57 -05:00
// SSE dare package block size.
sseDAREPackageBlockSize = 64 * 1024 // 64KiB bytes
// SSE dare package meta padding bytes.
sseDAREPackageMetaSize = 32 // 32 bytes
2017-11-07 18:18:59 -05:00
)
2017-11-10 20:21:23 -05:00
// SSE-C key derivation, key verification and key update:
// H: Hash function [32 = |H(m)|]
// AE: authenticated encryption scheme, AD: authenticated decryption scheme [m = AD(k, AE(k, m))]
2017-11-07 18:18:59 -05:00
//
2017-11-10 20:21:23 -05:00
// Key derivation:
// Input:
// key := 32 bytes # client provided key
// Re, Rm := 32 bytes, 32 bytes # uniformly random
2017-11-07 18:18:59 -05:00
//
2017-11-10 20:21:23 -05:00
// Seal:
// k := H(key || Re) # object encryption key
// r := H(Rm) # save as object metadata [ServerSideEncryptionIV]
// KeK := H(key || r) # key encryption key
// K := AE(KeK, k) # save as object metadata [ServerSideEncryptionSealedKey]
// ------------------------------------------------------------------------------------------------
// Key verification:
// Input:
// key := 32 bytes # client provided key
// r := 32 bytes # object metadata [ServerSideEncryptionIV]
// K := 32 bytes # object metadata [ServerSideEncryptionSealedKey]
2017-11-07 18:18:59 -05:00
//
2017-11-10 20:21:23 -05:00
// Open:
// KeK := H(key || r) # key encryption key
// k := AD(Kek, K) # object encryption key
// -------------------------------------------------------------------------------------------------
// Key update:
// Input:
// key := 32 bytes # old client provided key
// key' := 32 bytes # new client provided key
// Rm := 32 bytes # uniformly random
// r := 32 bytes # object metadata [ServerSideEncryptionIV]
// K := 32 bytes # object metadata [ServerSideEncryptionSealedKey]
2017-11-07 18:18:59 -05:00
//
2017-11-10 20:21:23 -05:00
// Update:
// 1. open:
// KeK := H(key || r) # key encryption key
// k := AD(Kek, K) # object encryption key
// 2. seal:
// r' := H(Rm) # save as object metadata [ServerSideEncryptionIV]
// KeK' := H(key' || r') # new key encryption key
// K' := AE(KeK', k) # save as object metadata [ServerSideEncryptionSealedKey]
2017-11-07 18:18:59 -05:00
const (
// ServerSideEncryptionIV is a 32 byte randomly generated IV used to derive an
2017-11-10 20:21:23 -05:00
// unique key encryption key from the client provided key. The combination of this value
// and the client-provided key MUST be unique.
2017-11-07 18:18:59 -05:00
ServerSideEncryptionIV = ReservedMetadataPrefix + "Server-Side-Encryption-Iv"
2017-11-10 20:21:23 -05:00
// ServerSideEncryptionSealAlgorithm identifies a combination of a cryptographic hash function and
// an authenticated en/decryption scheme to seal the object encryption key.
ServerSideEncryptionSealAlgorithm = ReservedMetadataPrefix + "Server-Side-Encryption-Seal-Algorithm"
2017-11-07 18:18:59 -05:00
2017-11-10 20:21:23 -05:00
// ServerSideEncryptionSealedKey is the sealed object encryption key. The sealed key can be decrypted
// by the key encryption key derived from the client provided key and the server-side-encryption IV.
ServerSideEncryptionSealedKey = ReservedMetadataPrefix + "Server-Side-Encryption-Sealed-Key"
2017-11-07 18:18:59 -05:00
)
2017-11-10 20:21:23 -05:00
// SSESealAlgorithmDareSha256 specifies DARE as authenticated en/decryption scheme and SHA256 as cryptographic
// hash function.
const SSESealAlgorithmDareSha256 = "DARE-SHA256"
2017-11-07 18:18:59 -05:00
2018-03-05 11:02:56 -05:00
// hasSSECustomerHeader returns true if the given HTTP header
2017-11-07 18:18:59 -05:00
// contains server-side-encryption with customer provided key fields.
2018-03-05 11:02:56 -05:00
func hasSSECustomerHeader ( header http . Header ) bool {
2017-11-07 18:18:59 -05:00
return header . Get ( SSECustomerAlgorithm ) != "" || header . Get ( SSECustomerKey ) != "" || header . Get ( SSECustomerKeyMD5 ) != ""
}
2018-03-05 11:02:56 -05:00
// hasSSECopyCustomerHeader returns true if the given HTTP header
2018-02-23 18:07:21 -05:00
// contains copy source server-side-encryption with customer provided key fields.
2018-03-05 11:02:56 -05:00
func hasSSECopyCustomerHeader ( header http . Header ) bool {
2018-02-23 18:07:21 -05:00
return header . Get ( SSECopyCustomerAlgorithm ) != "" || header . Get ( SSECopyCustomerKey ) != "" || header . Get ( SSECopyCustomerKeyMD5 ) != ""
}
// ParseSSECopyCustomerRequest parses the SSE-C header fields of the provided request.
// It returns the client provided key on success.
func ParseSSECopyCustomerRequest ( r * http . Request ) ( key [ ] byte , err error ) {
if ! globalIsSSL { // minio only supports HTTP or HTTPS requests not both at the same time
// we cannot use r.TLS == nil here because Go's http implementation reflects on
// the net.Conn and sets the TLS field of http.Request only if it's an tls.Conn.
// Minio uses a BufConn (wrapping a tls.Conn) so the type check within the http package
// will always fail -> r.TLS is always nil even for TLS requests.
return nil , errInsecureSSERequest
}
header := r . Header
if algorithm := header . Get ( SSECopyCustomerAlgorithm ) ; algorithm != SSECustomerAlgorithmAES256 {
return nil , errInvalidSSEAlgorithm
}
if header . Get ( SSECopyCustomerKey ) == "" {
return nil , errMissingSSEKey
}
if header . Get ( SSECopyCustomerKeyMD5 ) == "" {
return nil , errMissingSSEKeyMD5
}
key , err = base64 . StdEncoding . DecodeString ( header . Get ( SSECopyCustomerKey ) )
if err != nil {
return nil , errInvalidSSEKey
}
if len ( key ) != SSECustomerKeySize {
return nil , errInvalidSSEKey
}
// Make sure we purged the keys from http headers by now.
header . Del ( SSECopyCustomerKey )
keyMD5 , err := base64 . StdEncoding . DecodeString ( header . Get ( SSECopyCustomerKeyMD5 ) )
if err != nil {
return nil , errSSEKeyMD5Mismatch
}
if md5Sum := md5 . Sum ( key ) ; ! bytes . Equal ( md5Sum [ : ] , keyMD5 ) {
return nil , errSSEKeyMD5Mismatch
}
return key , nil
}
2017-11-07 18:18:59 -05:00
// ParseSSECustomerRequest parses the SSE-C header fields of the provided request.
// It returns the client provided key on success.
func ParseSSECustomerRequest ( r * http . Request ) ( key [ ] byte , err error ) {
2018-03-05 11:02:56 -05:00
return ParseSSECustomerHeader ( r . Header )
}
// ParseSSECustomerHeader parses the SSE-C header fields and returns
// the client provided key on success.
func ParseSSECustomerHeader ( header http . Header ) ( key [ ] byte , err error ) {
2017-11-07 18:18:59 -05:00
if ! globalIsSSL { // minio only supports HTTP or HTTPS requests not both at the same time
// we cannot use r.TLS == nil here because Go's http implementation reflects on
// the net.Conn and sets the TLS field of http.Request only if it's an tls.Conn.
// Minio uses a BufConn (wrapping a tls.Conn) so the type check within the http package
// will always fail -> r.TLS is always nil even for TLS requests.
return nil , errInsecureSSERequest
}
if algorithm := header . Get ( SSECustomerAlgorithm ) ; algorithm != SSECustomerAlgorithmAES256 {
return nil , errInvalidSSEAlgorithm
}
if header . Get ( SSECustomerKey ) == "" {
return nil , errMissingSSEKey
}
if header . Get ( SSECustomerKeyMD5 ) == "" {
return nil , errMissingSSEKeyMD5
}
key , err = base64 . StdEncoding . DecodeString ( header . Get ( SSECustomerKey ) )
if err != nil {
return nil , errInvalidSSEKey
}
if len ( key ) != SSECustomerKeySize {
return nil , errInvalidSSEKey
}
2018-02-23 18:07:21 -05:00
// Make sure we purged the keys from http headers by now.
header . Del ( SSECustomerKey )
2017-11-07 18:18:59 -05:00
keyMD5 , err := base64 . StdEncoding . DecodeString ( header . Get ( SSECustomerKeyMD5 ) )
if err != nil {
return nil , errSSEKeyMD5Mismatch
}
if md5Sum := md5 . Sum ( key ) ; ! bytes . Equal ( md5Sum [ : ] , keyMD5 ) {
return nil , errSSEKeyMD5Mismatch
}
return key , nil
}
2018-02-23 18:07:21 -05:00
// This function rotates old to new key.
func rotateKey ( oldKey [ ] byte , newKey [ ] byte , metadata map [ string ] string ) error {
if subtle . ConstantTimeCompare ( oldKey , newKey ) == 1 {
return nil
}
delete ( metadata , SSECustomerKey ) // make sure we do not save the key by accident
if metadata [ ServerSideEncryptionSealAlgorithm ] != SSESealAlgorithmDareSha256 { // currently DARE-SHA256 is the only option
return errObjectTampered
}
iv , err := base64 . StdEncoding . DecodeString ( metadata [ ServerSideEncryptionIV ] )
2018-03-01 14:37:57 -05:00
if err != nil || len ( iv ) != SSEIVSize {
2018-02-23 18:07:21 -05:00
return errObjectTampered
}
sealedKey , err := base64 . StdEncoding . DecodeString ( metadata [ ServerSideEncryptionSealedKey ] )
if err != nil || len ( sealedKey ) != 64 {
return errObjectTampered
}
sha := sha256 . New ( ) // derive key encryption key
sha . Write ( oldKey )
sha . Write ( iv )
keyEncryptionKey := sha . Sum ( nil )
objectEncryptionKey := bytes . NewBuffer ( nil ) // decrypt object encryption key
n , err := sio . Decrypt ( objectEncryptionKey , bytes . NewReader ( sealedKey ) , sio . Config {
Key : keyEncryptionKey ,
} )
if n != 32 || err != nil {
// Either the provided key does not match or the object was tampered.
// To provide strict AWS S3 compatibility we return: access denied.
return errSSEKeyMismatch
}
nonce := make ( [ ] byte , 32 ) // generate random values for key derivation
if _ , err = io . ReadFull ( rand . Reader , nonce ) ; err != nil {
return err
}
niv := sha256 . Sum256 ( nonce [ : ] ) // derive key encryption key
sha = sha256 . New ( )
sha . Write ( newKey )
sha . Write ( niv [ : ] )
keyEncryptionKey = sha . Sum ( nil )
sealedKeyW := bytes . NewBuffer ( nil ) // sealedKey := 16 byte header + 32 byte payload + 16 byte tag
n , err = sio . Encrypt ( sealedKeyW , bytes . NewReader ( objectEncryptionKey . Bytes ( ) ) , sio . Config {
Key : keyEncryptionKey ,
} )
if n != 64 || err != nil {
return errors . New ( "failed to seal object encryption key" ) // if this happens there's a bug in the code (may panic ?)
2017-11-07 18:18:59 -05:00
}
2018-02-23 18:07:21 -05:00
metadata [ ServerSideEncryptionIV ] = base64 . StdEncoding . EncodeToString ( niv [ : ] )
metadata [ ServerSideEncryptionSealAlgorithm ] = SSESealAlgorithmDareSha256
metadata [ ServerSideEncryptionSealedKey ] = base64 . StdEncoding . EncodeToString ( sealedKeyW . Bytes ( ) )
return nil
}
2018-03-01 14:37:57 -05:00
func newEncryptMetadata ( key [ ] byte , metadata map [ string ] string ) ( [ ] byte , error ) {
2017-11-07 18:18:59 -05:00
delete ( metadata , SSECustomerKey ) // make sure we do not save the key by accident
// security notice:
2017-11-10 20:21:23 -05:00
// - If the first 32 bytes of the random value are ever repeated under the same client-provided
// key the encrypted object will not be tamper-proof. [ P(coll) ~= 1 / 2^(256 / 2)]
// - If the last 32 bytes of the random value are ever repeated under the same client-provided
// key an adversary may be able to extract the object encryption key. This depends on the
// authenticated en/decryption scheme. The DARE format will generate an 8 byte nonce which must
// be repeated in addition to reveal the object encryption key.
// [ P(coll) ~= 1 / 2^((256 + 64) / 2) ]
2018-03-01 14:37:57 -05:00
nonce := make ( [ ] byte , 32 + SSEIVSize ) // generate random values for key derivation
2018-02-23 18:07:21 -05:00
if _ , err := io . ReadFull ( rand . Reader , nonce ) ; err != nil {
2017-11-07 18:18:59 -05:00
return nil , err
}
2017-11-10 20:21:23 -05:00
sha := sha256 . New ( ) // derive object encryption key
sha . Write ( key )
sha . Write ( nonce [ : 32 ] )
objectEncryptionKey := sha . Sum ( nil )
2017-11-07 18:18:59 -05:00
2017-11-10 20:21:23 -05:00
iv := sha256 . Sum256 ( nonce [ 32 : ] ) // derive key encryption key
sha = sha256 . New ( )
sha . Write ( key )
sha . Write ( iv [ : ] )
keyEncryptionKey := sha . Sum ( nil )
2017-11-07 18:18:59 -05:00
2017-11-10 20:21:23 -05:00
sealedKey := bytes . NewBuffer ( nil ) // sealedKey := 16 byte header + 32 byte payload + 16 byte tag
n , err := sio . Encrypt ( sealedKey , bytes . NewReader ( objectEncryptionKey ) , sio . Config {
Key : keyEncryptionKey ,
} )
if n != 64 || err != nil {
return nil , errors . New ( "failed to seal object encryption key" ) // if this happens there's a bug in the code (may panic ?)
}
2018-03-01 14:37:57 -05:00
metadata [ ServerSideEncryptionIV ] = base64 . StdEncoding . EncodeToString ( iv [ : ] )
metadata [ ServerSideEncryptionSealAlgorithm ] = SSESealAlgorithmDareSha256
metadata [ ServerSideEncryptionSealedKey ] = base64 . StdEncoding . EncodeToString ( sealedKey . Bytes ( ) )
return objectEncryptionKey , nil
}
func newEncryptReader ( content io . Reader , key [ ] byte , metadata map [ string ] string ) ( io . Reader , error ) {
objectEncryptionKey , err := newEncryptMetadata ( key , metadata )
if err != nil {
return nil , err
}
2017-11-10 20:21:23 -05:00
reader , err := sio . EncryptReader ( content , sio . Config { Key : objectEncryptionKey } )
2017-11-07 18:18:59 -05:00
if err != nil {
return nil , errInvalidSSEKey
}
return reader , nil
}
2018-02-23 18:07:21 -05:00
// EncryptRequest takes the client provided content and encrypts the data
// with the client provided key. It also marks the object as client-side-encrypted
// and sets the correct headers.
func EncryptRequest ( content io . Reader , r * http . Request , metadata map [ string ] string ) ( io . Reader , error ) {
2017-11-07 18:18:59 -05:00
key , err := ParseSSECustomerRequest ( r )
if err != nil {
return nil , err
}
2018-02-23 18:07:21 -05:00
return newEncryptReader ( content , key , metadata )
}
2017-11-07 18:18:59 -05:00
2018-02-23 18:07:21 -05:00
// DecryptCopyRequest decrypts the object with the client provided key. It also removes
// the client-side-encryption metadata from the object and sets the correct headers.
func DecryptCopyRequest ( client io . Writer , r * http . Request , metadata map [ string ] string ) ( io . WriteCloser , error ) {
key , err := ParseSSECopyCustomerRequest ( r )
if err != nil {
return nil , err
}
delete ( metadata , SSECopyCustomerKey ) // make sure we do not save the key by accident
return newDecryptWriter ( client , key , 0 , metadata )
}
2018-03-01 14:37:57 -05:00
func decryptObjectInfo ( key [ ] byte , metadata map [ string ] string ) ( [ ] byte , error ) {
2017-11-10 20:21:23 -05:00
if metadata [ ServerSideEncryptionSealAlgorithm ] != SSESealAlgorithmDareSha256 { // currently DARE-SHA256 is the only option
2017-11-07 18:18:59 -05:00
return nil , errObjectTampered
}
2017-11-10 20:21:23 -05:00
iv , err := base64 . StdEncoding . DecodeString ( metadata [ ServerSideEncryptionIV ] )
2018-03-01 14:37:57 -05:00
if err != nil || len ( iv ) != SSEIVSize {
2017-11-07 18:18:59 -05:00
return nil , errObjectTampered
}
2017-11-10 20:21:23 -05:00
sealedKey , err := base64 . StdEncoding . DecodeString ( metadata [ ServerSideEncryptionSealedKey ] )
if err != nil || len ( sealedKey ) != 64 {
2017-11-07 18:18:59 -05:00
return nil , errObjectTampered
}
2017-11-10 20:21:23 -05:00
sha := sha256 . New ( ) // derive key encryption key
sha . Write ( key )
sha . Write ( iv )
keyEncryptionKey := sha . Sum ( nil )
objectEncryptionKey := bytes . NewBuffer ( nil ) // decrypt object encryption key
n , err := sio . Decrypt ( objectEncryptionKey , bytes . NewReader ( sealedKey ) , sio . Config {
Key : keyEncryptionKey ,
} )
if n != 32 || err != nil {
2017-11-20 17:04:10 -05:00
// Either the provided key does not match or the object was tampered.
// To provide strict AWS S3 compatibility we return: access denied.
return nil , errSSEKeyMismatch
2017-11-07 18:18:59 -05:00
}
2018-03-01 14:37:57 -05:00
return objectEncryptionKey . Bytes ( ) , nil
}
2017-11-07 18:18:59 -05:00
2018-03-01 14:37:57 -05:00
func newDecryptWriter ( client io . Writer , key [ ] byte , seqNumber uint32 , metadata map [ string ] string ) ( io . WriteCloser , error ) {
objectEncryptionKey , err := decryptObjectInfo ( key , metadata )
if err != nil {
return nil , err
}
return newDecryptWriterWithObjectKey ( client , objectEncryptionKey , seqNumber , metadata )
}
func newDecryptWriterWithObjectKey ( client io . Writer , objectEncryptionKey [ ] byte , seqNumber uint32 , metadata map [ string ] string ) ( io . WriteCloser , error ) {
2018-02-23 18:07:21 -05:00
writer , err := sio . DecryptWriter ( client , sio . Config {
2018-03-01 14:37:57 -05:00
Key : objectEncryptionKey ,
2018-02-23 18:07:21 -05:00
SequenceNumber : seqNumber ,
} )
2017-11-07 18:18:59 -05:00
if err != nil {
return nil , errInvalidSSEKey
}
delete ( metadata , ServerSideEncryptionIV )
2017-11-10 20:21:23 -05:00
delete ( metadata , ServerSideEncryptionSealAlgorithm )
delete ( metadata , ServerSideEncryptionSealedKey )
2018-03-02 20:24:02 -05:00
delete ( metadata , ReservedMetadataPrefix + "Encrypted-Multipart" )
2017-11-07 18:18:59 -05:00
return writer , nil
}
2018-02-23 18:07:21 -05:00
// DecryptRequestWithSequenceNumber decrypts the object with the client provided key. It also removes
// the client-side-encryption metadata from the object and sets the correct headers.
func DecryptRequestWithSequenceNumber ( client io . Writer , r * http . Request , seqNumber uint32 , metadata map [ string ] string ) ( io . WriteCloser , error ) {
key , err := ParseSSECustomerRequest ( r )
if err != nil {
return nil , err
}
delete ( metadata , SSECustomerKey ) // make sure we do not save the key by accident
return newDecryptWriter ( client , key , seqNumber , metadata )
}
// DecryptRequest decrypts the object with the client provided key. It also removes
// the client-side-encryption metadata from the object and sets the correct headers.
func DecryptRequest ( client io . Writer , r * http . Request , metadata map [ string ] string ) ( io . WriteCloser , error ) {
return DecryptRequestWithSequenceNumber ( client , r , 0 , metadata )
}
2018-03-01 14:37:57 -05:00
// DecryptBlocksWriter - decrypts multipart parts, while implementing a io.Writer compatible interface.
type DecryptBlocksWriter struct {
// Original writer where the plain data will be written
writer io . Writer
// Current decrypter for the current encrypted data block
decrypter io . WriteCloser
// Start sequence number
startSeqNum uint32
// Current part index
partIndex int
// Parts information
parts [ ] objectPartInfo
req * http . Request
metadata map [ string ] string
partEncRelOffset int64
2018-03-02 20:24:02 -05:00
copySource bool
2018-03-01 14:37:57 -05:00
// Customer Key
customerKeyHeader string
}
func ( w * DecryptBlocksWriter ) buildDecrypter ( partID int ) error {
m := make ( map [ string ] string )
for k , v := range w . metadata {
m [ k ] = v
}
// Initialize the first decrypter, new decrypters will be initialized in Write() operation as needed.
2018-03-02 20:24:02 -05:00
var key [ ] byte
var err error
if w . copySource {
w . req . Header . Set ( SSECopyCustomerKey , w . customerKeyHeader )
key , err = ParseSSECopyCustomerRequest ( w . req )
} else {
w . req . Header . Set ( SSECustomerKey , w . customerKeyHeader )
key , err = ParseSSECustomerRequest ( w . req )
}
2018-03-01 14:37:57 -05:00
if err != nil {
return err
}
objectEncryptionKey , err := decryptObjectInfo ( key , m )
if err != nil {
return err
}
var partIDbin [ 4 ] byte
binary . LittleEndian . PutUint32 ( partIDbin [ : ] , uint32 ( partID ) ) // marshal part ID
mac := hmac . New ( sha256 . New , objectEncryptionKey ) // derive part encryption key from part ID and object key
mac . Write ( partIDbin [ : ] )
partEncryptionKey := mac . Sum ( nil )
2018-03-02 20:24:02 -05:00
// make sure we do not save the key by accident
if w . copySource {
delete ( m , SSECopyCustomerKey )
} else {
delete ( m , SSECustomerKey )
}
2018-03-01 14:37:57 -05:00
2018-03-02 20:24:02 -05:00
// make sure to provide a NopCloser such that a Close
// on sio.decryptWriter doesn't close the underlying writer's
// close which perhaps can close the stream prematurely.
decrypter , err := newDecryptWriterWithObjectKey ( ioutil . NopCloser ( w . writer ) , partEncryptionKey , w . startSeqNum , m )
2018-03-01 14:37:57 -05:00
if err != nil {
return err
}
2018-02-23 18:07:21 -05:00
2018-03-01 14:37:57 -05:00
if w . decrypter != nil {
2018-03-02 20:24:02 -05:00
// Pro-actively close the writer such that any pending buffers
// are flushed already before we allocate a new decrypter.
2018-03-01 14:37:57 -05:00
err = w . decrypter . Close ( )
if err != nil {
return err
}
2018-02-23 18:07:21 -05:00
}
2018-03-01 14:37:57 -05:00
w . decrypter = decrypter
return nil
}
func ( w * DecryptBlocksWriter ) Write ( p [ ] byte ) ( int , error ) {
var err error
var n1 int
if int64 ( len ( p ) ) < w . parts [ w . partIndex ] . Size - w . partEncRelOffset {
n1 , err = w . decrypter . Write ( p )
if err != nil {
return 0 , err
}
w . partEncRelOffset += int64 ( n1 )
} else {
n1 , err = w . decrypter . Write ( p [ : w . parts [ w . partIndex ] . Size - w . partEncRelOffset ] )
if err != nil {
return 0 , err
}
// We should now proceed to next part, reset all values appropriately.
w . partEncRelOffset = 0
w . startSeqNum = 0
w . partIndex ++
err = w . buildDecrypter ( w . partIndex + 1 )
if err != nil {
return 0 , err
}
n1 , err = w . decrypter . Write ( p [ n1 : ] )
if err != nil {
return 0 , err
}
w . partEncRelOffset += int64 ( n1 )
}
return len ( p ) , nil
}
// Close closes the LimitWriter. It behaves like io.Closer.
func ( w * DecryptBlocksWriter ) Close ( ) error {
if w . decrypter != nil {
err := w . decrypter . Close ( )
if err != nil {
return err
}
}
if closer , ok := w . writer . ( io . Closer ) ; ok {
return closer . Close ( )
}
return nil
}
2018-03-02 20:24:02 -05:00
// DecryptAllBlocksCopyRequest - setup a struct which can decrypt many concatenated encrypted data
// parts information helps to know the boundaries of each encrypted data block, this function decrypts
// all parts starting from part-1.
func DecryptAllBlocksCopyRequest ( client io . Writer , r * http . Request , objInfo ObjectInfo ) ( io . WriteCloser , int64 , error ) {
w , _ , size , err := DecryptBlocksRequest ( client , r , 0 , objInfo . Size , objInfo , true )
return w , size , err
}
2018-03-01 14:37:57 -05:00
// DecryptBlocksRequest - setup a struct which can decrypt many concatenated encrypted data
// parts information helps to know the boundaries of each encrypted data block.
2018-03-02 20:24:02 -05:00
func DecryptBlocksRequest ( client io . Writer , r * http . Request , startOffset , length int64 , objInfo ObjectInfo , copySource bool ) ( io . WriteCloser , int64 , int64 , error ) {
2018-03-01 14:37:57 -05:00
seqNumber , encStartOffset , encLength := getEncryptedStartOffset ( startOffset , length )
// Encryption length cannot be bigger than the file size, if it is
// which is allowed in AWS S3, we simply default to EncryptedSize().
if encLength + encStartOffset > objInfo . EncryptedSize ( ) {
encLength = objInfo . EncryptedSize ( ) - encStartOffset
}
if len ( objInfo . Parts ) == 0 || ! objInfo . IsEncryptedMultipart ( ) {
2018-03-02 20:24:02 -05:00
var writer io . WriteCloser
var err error
if copySource {
writer , err = DecryptCopyRequest ( client , r , objInfo . UserDefined )
} else {
writer , err = DecryptRequestWithSequenceNumber ( client , r , seqNumber , objInfo . UserDefined )
}
2018-03-01 14:37:57 -05:00
if err != nil {
return nil , 0 , 0 , err
}
return writer , encStartOffset , encLength , nil
}
var partStartIndex int
var partStartOffset = startOffset
// Skip parts until final offset maps to a particular part offset.
for i , part := range objInfo . Parts {
2018-03-19 12:48:12 -04:00
decryptedSize , err := sio . DecryptedSize ( uint64 ( part . Size ) )
2018-03-01 14:37:57 -05:00
if err != nil {
2018-03-19 12:48:12 -04:00
return nil , - 1 , - 1 , errObjectTampered
2018-03-01 14:37:57 -05:00
}
partStartIndex = i
// Offset is smaller than size we have reached the
// proper part offset, break out we start from
// this part index.
2018-03-19 12:48:12 -04:00
if partStartOffset < int64 ( decryptedSize ) {
2018-03-01 14:37:57 -05:00
break
}
// Continue to look for next part.
2018-03-19 12:48:12 -04:00
partStartOffset -= int64 ( decryptedSize )
2018-03-01 14:37:57 -05:00
}
startSeqNum := partStartOffset / sseDAREPackageBlockSize
partEncRelOffset := int64 ( startSeqNum ) * ( sseDAREPackageBlockSize + sseDAREPackageMetaSize )
w := & DecryptBlocksWriter {
writer : client ,
startSeqNum : uint32 ( startSeqNum ) ,
partEncRelOffset : partEncRelOffset ,
parts : objInfo . Parts ,
partIndex : partStartIndex ,
req : r ,
customerKeyHeader : r . Header . Get ( SSECustomerKey ) ,
2018-03-02 20:24:02 -05:00
copySource : copySource ,
}
w . metadata = map [ string ] string { }
// Copy encryption metadata for internal use.
for k , v := range objInfo . UserDefined {
w . metadata [ k ] = v
2018-03-01 14:37:57 -05:00
}
2018-03-02 20:24:02 -05:00
// Purge all the encryption headers.
delete ( objInfo . UserDefined , ServerSideEncryptionIV )
delete ( objInfo . UserDefined , ServerSideEncryptionSealAlgorithm )
delete ( objInfo . UserDefined , ServerSideEncryptionSealedKey )
delete ( objInfo . UserDefined , ReservedMetadataPrefix + "Encrypted-Multipart" )
if w . copySource {
w . customerKeyHeader = r . Header . Get ( SSECopyCustomerKey )
}
if err := w . buildDecrypter ( partStartIndex + 1 ) ; err != nil {
return nil , 0 , 0 , err
}
2018-03-01 14:37:57 -05:00
return w , encStartOffset , encLength , nil
}
// getEncryptedStartOffset - fetch sequence number, encrypted start offset and encrypted length.
func getEncryptedStartOffset ( offset , length int64 ) ( seqNumber uint32 , encOffset int64 , encLength int64 ) {
onePkgSize := int64 ( sseDAREPackageBlockSize + sseDAREPackageMetaSize )
seqNumber = uint32 ( offset / sseDAREPackageBlockSize )
encOffset = int64 ( seqNumber ) * onePkgSize
// The math to compute the encrypted length is always
// originalLength i.e (offset+length-1) to be divided under
// 64KiB blocks which is the payload size for each encrypted
// block. This is then multiplied by final package size which
// is basically 64KiB + 32. Finally negate the encrypted offset
// to get the final encrypted length on disk.
encLength = ( ( offset + length ) / sseDAREPackageBlockSize ) * onePkgSize - encOffset
// Check for the remainder, to figure if we need one extract package to read from.
if ( offset + length ) % sseDAREPackageBlockSize > 0 {
encLength += onePkgSize
}
return seqNumber , encOffset , encLength
}
// IsEncryptedMultipart - is the encrypted content multiparted?
func ( o * ObjectInfo ) IsEncryptedMultipart ( ) bool {
_ , ok := o . UserDefined [ ReservedMetadataPrefix + "Encrypted-Multipart" ]
return ok
2018-02-23 18:07:21 -05:00
}
2017-11-07 18:18:59 -05:00
// IsEncrypted returns true if the object is marked as encrypted.
func ( o * ObjectInfo ) IsEncrypted ( ) bool {
if _ , ok := o . UserDefined [ ServerSideEncryptionIV ] ; ok {
return true
}
2017-11-10 20:21:23 -05:00
if _ , ok := o . UserDefined [ ServerSideEncryptionSealAlgorithm ] ; ok {
2017-11-07 18:18:59 -05:00
return true
}
2017-11-10 20:21:23 -05:00
if _ , ok := o . UserDefined [ ServerSideEncryptionSealedKey ] ; ok {
2017-11-07 18:18:59 -05:00
return true
}
return false
}
2018-03-01 14:37:57 -05:00
// IsEncrypted returns true if the object is marked as encrypted.
func ( li * ListPartsInfo ) IsEncrypted ( ) bool {
if _ , ok := li . UserDefined [ ServerSideEncryptionIV ] ; ok {
return true
}
if _ , ok := li . UserDefined [ ServerSideEncryptionSealAlgorithm ] ; ok {
return true
}
if _ , ok := li . UserDefined [ ServerSideEncryptionSealedKey ] ; ok {
return true
}
return false
}
2017-11-07 18:18:59 -05:00
// DecryptedSize returns the size of the object after decryption in bytes.
// It returns an error if the object is not encrypted or marked as encrypted
// but has an invalid size.
// DecryptedSize panics if the referred object is not encrypted.
func ( o * ObjectInfo ) DecryptedSize ( ) ( int64 , error ) {
if ! o . IsEncrypted ( ) {
panic ( "cannot compute decrypted size of an object which is not encrypted" )
}
2018-03-19 12:48:12 -04:00
size , err := sio . DecryptedSize ( uint64 ( o . Size ) )
if err != nil {
err = errObjectTampered // assign correct error type
}
return int64 ( size ) , err
2017-11-07 18:18:59 -05:00
}
// EncryptedSize returns the size of the object after encryption.
// An encrypted object is always larger than a plain object
// except for zero size objects.
func ( o * ObjectInfo ) EncryptedSize ( ) int64 {
2018-03-19 12:48:12 -04:00
size , err := sio . EncryptedSize ( uint64 ( o . Size ) )
if err != nil {
panic ( err ) // Since AWS S3 allows parts to be 5GB at most this cannot happen - sio max. size is 256 TB
2017-11-07 18:18:59 -05:00
}
2018-03-19 12:48:12 -04:00
return int64 ( size )
2017-11-07 18:18:59 -05:00
}
2018-02-23 18:07:21 -05:00
// DecryptCopyObjectInfo tries to decrypt the provided object if it is encrypted.
// It fails if the object is encrypted and the HTTP headers don't contain
// SSE-C headers or the object is not encrypted but SSE-C headers are provided. (AWS behavior)
// DecryptObjectInfo returns 'ErrNone' if the object is not encrypted or the
// decryption succeeded.
//
// DecryptCopyObjectInfo also returns whether the object is encrypted or not.
func DecryptCopyObjectInfo ( info * ObjectInfo , headers http . Header ) ( apiErr APIErrorCode , encrypted bool ) {
// Directories are never encrypted.
if info . IsDir {
return ErrNone , false
}
2018-03-05 11:02:56 -05:00
if apiErr , encrypted = ErrNone , info . IsEncrypted ( ) ; ! encrypted && hasSSECopyCustomerHeader ( headers ) {
2018-02-23 18:07:21 -05:00
apiErr = ErrInvalidEncryptionParameters
} else if encrypted {
2018-03-05 11:02:56 -05:00
if ! hasSSECopyCustomerHeader ( headers ) {
2018-02-23 18:07:21 -05:00
apiErr = ErrSSEEncryptedObject
return
}
var err error
if info . Size , err = info . DecryptedSize ( ) ; err != nil {
apiErr = toAPIErrorCode ( err )
}
}
return
}
2017-11-07 18:18:59 -05:00
// DecryptObjectInfo tries to decrypt the provided object if it is encrypted.
// It fails if the object is encrypted and the HTTP headers don't contain
// SSE-C headers or the object is not encrypted but SSE-C headers are provided. (AWS behavior)
// DecryptObjectInfo returns 'ErrNone' if the object is not encrypted or the
// decryption succeeded.
//
// DecryptObjectInfo also returns whether the object is encrypted or not.
func DecryptObjectInfo ( info * ObjectInfo , headers http . Header ) ( apiErr APIErrorCode , encrypted bool ) {
2018-02-23 18:07:21 -05:00
// Directories are never encrypted.
if info . IsDir {
return ErrNone , false
}
2018-03-05 11:02:56 -05:00
if apiErr , encrypted = ErrNone , info . IsEncrypted ( ) ; ! encrypted && hasSSECustomerHeader ( headers ) {
2017-11-07 18:18:59 -05:00
apiErr = ErrInvalidEncryptionParameters
} else if encrypted {
2018-03-05 11:02:56 -05:00
if ! hasSSECustomerHeader ( headers ) {
2017-11-07 18:18:59 -05:00
apiErr = ErrSSEEncryptedObject
return
}
var err error
if info . Size , err = info . DecryptedSize ( ) ; err != nil {
apiErr = toAPIErrorCode ( err )
}
}
return
}