Encryption support producer #560
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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 pulsar | ||
|
|
||
| import "github.com/apache/pulsar-client-go/pulsar/crypto" | ||
|
|
||
| // ProducerEncryptionInfo encryption related fields required by the producer | ||
| type ProducerEncryptionInfo struct { | ||
| // KeyReader read RSA public/private key pairs | ||
| Keyreader crypto.KeyReader | ||
|
|
||
|
|
||
| // MessageCrypto used to encrypt and decrypt the data and session keys | ||
| MessageCrypto crypto.MessageCrypto | ||
|
|
||
| // Keys list of encryption key names to encrypt session key | ||
| Keys []string | ||
|
|
||
| // ProducerCryptoFailureAction action to be taken on failure of message encryption | ||
| // default is ProducerCryptoFailureActionFail | ||
| ProducerCryptoFailureAction int | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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 crypto | ||
|
|
||
| import ( | ||
| "github.com/apache/pulsar-client-go/pulsar/crypto" | ||
| pb "github.com/apache/pulsar-client-go/pulsar/internal/pulsar_proto" | ||
| ) | ||
|
|
||
| // Encryptor support encryption | ||
| type Encryptor interface { | ||
| Encrypt([]byte, crypto.MessageMetadataSupplier) ([]byte, error) | ||
|
There was a problem hiding this comment. Since this is internal we can pass the *pb.MessageMetadata and avoid having to create a supplier for each message when encryption is not being used. |
||
| } | ||
|
|
||
| // NewMessageMetadataSupplier returns wrapper for message metadata | ||
| func NewMessageMetadataSupplier(msgMetadata *pb.MessageMetadata) crypto.MessageMetadataSupplier { | ||
| return crypto.NewMessageMetadataSupplier(msgMetadata) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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 crypto | ||
|
|
||
| import "github.com/apache/pulsar-client-go/pulsar/crypto" | ||
|
|
||
| type noopEncryptor struct{} | ||
|
|
||
| func NewNoopEncryptor() Encryptor { | ||
| return &noopEncryptor{} | ||
| } | ||
|
|
||
| // Encrypt Noop ecryptor | ||
| func (e *noopEncryptor) Encrypt(data []byte, msgMetadata crypto.MessageMetadataSupplier) ([]byte, error) { | ||
| return data, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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 crypto | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/apache/pulsar-client-go/pulsar/crypto" | ||
| "github.com/apache/pulsar-client-go/pulsar/log" | ||
| ) | ||
|
|
||
| type producerEncryptor struct { | ||
| keys []string | ||
| keyReader crypto.KeyReader | ||
| messageCrypto crypto.MessageCrypto | ||
| logger log.Logger | ||
| producerCryptoFailureAction int | ||
| } | ||
|
|
||
| func NewProducerEncryptor(keys []string, | ||
| keyReader crypto.KeyReader, | ||
| messageCrypto crypto.MessageCrypto, | ||
| producerCryptoFailureAction int, | ||
| logger log.Logger) Encryptor { | ||
| return &producerEncryptor{ | ||
| keys: keys, | ||
| keyReader: keyReader, | ||
| messageCrypto: messageCrypto, | ||
| logger: logger, | ||
| producerCryptoFailureAction: producerCryptoFailureAction, | ||
| } | ||
| } | ||
|
|
||
| // Encrypt producer encryptor | ||
| func (e *producerEncryptor) Encrypt(payload []byte, msgMetadata crypto.MessageMetadataSupplier) ([]byte, error) { | ||
| // encryption is enabled but KeyReader interface is not implemented | ||
| if e.keyReader == nil { | ||
|
There was a problem hiding this comment. Should this be detected and an error raised while setting up the producer? |
||
| // crypto failure action is set to send | ||
| // send unencrypted message | ||
| if e.producerCryptoFailureAction == crypto.ProducerCryptoFailureActionSend { | ||
| return payload, nil | ||
| } | ||
| return nil, fmt.Errorf("KeyReader interface is not implemented and ProducerCryptoFailureAction is set to fail") | ||
| } | ||
|
|
||
| // encrypt payload | ||
| encryptedPayload, err := e.messageCrypto.Encrypt(e.keys, e.keyReader, msgMetadata, payload) | ||
|
|
||
| // error encryping the payload | ||
| if err != nil { | ||
| // error occurred in encrypting the payload | ||
| // crypto ProducerCryptoFailureAction is set to send | ||
| // send unencrypted message | ||
| if e.producerCryptoFailureAction == crypto.ProducerCryptoFailureActionSend { | ||
| e.logger.Errorf("Encryption of payload failed : %v", err) | ||
| e.logger.Warn("ProducerCryptoFailureAction is set to send, sending unecrypted message") | ||
|
There was a problem hiding this comment. I would log only one warning message here. |
||
| return payload, nil | ||
| } | ||
|
|
||
| return nil, fmt.Errorf("ProducerCryptoFailureAction is set to Fail and error occurred in encrypting payload :%v", err) | ||
| } | ||
| return encryptedPayload, nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Curious why is the mod and sum file changing? Can these changes be done in a separate PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me recheck again :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
synced with master branch