Private Encrypted Channels docs #250
Conversation
daniellevass
changed the title
README.md
Outdated
| Similar to Private channels, you can also subscribe to a | ||
| [private encrypted channel](https://pusher.com/docs/channels/using_channels/encrypted-channels) | ||
| which means the data passed through Pusher is encrypted and only possible to | ||
| decrypt using the shared secret you have have. |
README.md
Outdated
| [demonstration endpoint to look at using nodejs](https://github.com/pusher/pusher-channels-auth-example#using-e2e-encryption). | ||
|
|
||
| To get started you need to subscribe to your channel, provide a `PrivateEncryptedChannelEventListener` | ||
| listener, and a list of the events you are interested in, for example: |
There was a problem hiding this comment.
...Listenerlistener
maybe drop the second listener? idk though it's not wrong it just sounds odd.
There was a problem hiding this comment.
👍 thank you! i originally had it there because i use listener on it's own in the example, but i think it's probably unnecessary.
Codecov Report
@@ Coverage Diff @@
## decrypt-integration #250 +/- ##
=========================================================
+ Coverage 77.02% 77.58% +0.56%
- Complexity 270 299 +29
=========================================================
Files 33 33
Lines 2350 2445 +95
Branches 115 125 +10
=========================================================
+ Hits 1810 1897 +87
- Misses 488 495 +7
- Partials 52 53 +1
Continue to review full report at Codecov.
|
README.md
Outdated
| Similar to Private channels, you can also subscribe to a | ||
| [private encrypted channel](https://pusher.com/docs/channels/using_channels/encrypted-channels) | ||
| which means the data passed through Pusher is encrypted and only possible to | ||
| decrypt using the shared secret you have. |
There was a problem hiding this comment.
I'm not quite sure about the final part of this sentence - whether it conveys the capability of the encryption clearly.
For reference, see the wording on the node server library, first sentence here: https://github.com/pusher/pusher-http-node#end-to-end-encryption-beta.
There was a problem hiding this comment.
Yeah, I struggled with the correct terminology to use - I've updated it to read:
Similar to Private channels, you can also subscribe to a
[private encrypted channel](https://pusher.com/docs/channels/using_channels/encrypted-channels).
This library now fully supports end-to-end encryption.
This means that only you and your connected clients will be able to read
your messages. Pusher cannot decrypt them.
Does that make it clearer?
| ConnectionEventListener, PrivateEncryptedChannelEventListener { | ||
|
|
||
| private String apiKey = "FILL_ME_IN"; // "key" at https://dashboard.pusher.com | ||
| private String key = "FILL_ME_IN"; |
There was a problem hiding this comment.
I think with so little context to the variable name, it's worth keeping at least a comment directing people to the dashboard to get one.
In general, I think apiKey is a pretty common term and will help people grasp quicker where they would probably find it.
There was a problem hiding this comment.
I've written in the comment at the top of the file they can get all that info from the dashboard - but i think your right the variable name should be more descriptive - maybe even channelsKey?
What
Added docs