Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 52 lines (38 sloc) 4.983 kb
3149403f »
2012-07-06 Readme revisions.
1 #Connecting everyone on Earth in < 0.25s !
2 PubNub is a cross-platform client-to-client (1:1 and 1:many) push service in the cloud, capable of broadcasting real-time messages to millions of web and mobile clients simultaneously, in less than a quarter second!
8dc572b1 »
2012-03-03 added Function Definitions for Pub/Sub/History and more to README.md …
3
3149403f »
2012-07-06 Readme revisions.
4 Optimized for both web and mobile, our scalable, global network of redundant data centers provides lightning-fast, reliable message delivery. We're up to 100 messages/second faster than possible with WebSockets alone, and **cross-platform compatibility across all phones, tablets, browsers, programming languages, and APIs is always guaranteed!**
8dc572b1 »
2012-03-03 added Function Definitions for Pub/Sub/History and more to README.md …
5
27fc4d7d »
2014-03-25 Update README.md
6 #Support and Issues
7d022bf2 »
2014-03-25 Update README.md
7 Please email us at support@pubnub.com if you have any questions or issues with the client SDKs. Alternatively, you can open an issue in the Github repo of the client you have the concern about.
8dc572b1 »
2012-03-03 added Function Definitions for Pub/Sub/History and more to README.md …
8
3149403f »
2012-07-06 Readme revisions.
9 #Supported Languages and Frameworks
10 The current list of supported languages and frameworks can be found on our [github page](http://www.google.com/url?q=https%3A%2F%2Fgithub.com%2Fpubnub%2Fpubnub-api&sa=D&sntz=1&usg=AFQjCNE-eofH-mEn6I8uFXa7P2y72ds02Q).
8dc572b1 »
2012-03-03 added Function Definitions for Pub/Sub/History and more to README.md …
11
3149403f »
2012-07-06 Readme revisions.
12 #Contact Us
13 Contact information for support, sales, and general purpose inquiries can found at http://www.pubnub.com/contact-us.
8dc572b1 »
2012-03-03 added Function Definitions for Pub/Sub/History and more to README.md …
14
3149403f »
2012-07-06 Readme revisions.
15 #Demo and Webcast Links
8e55f054 »
2012-03-05 added quick description and link regarding PubNub Cryptography and Ci…
16
f5d508d4 »
2012-07-06 Fixed broken links.
17 Vimeo: [https://vimeo.com/pubnub](https://vimeo.com/pubnub)<br>
18 YouTube: [http://www.youtube.com/playlist?p=PLF0BA2B6DAAF4FBBF](http://www.youtube.com/playlist?p=PLF0BA2B6DAAF4FBBF)<br>
19 Showcase: [http://www.pubnub.com/blog](http://www.pubnub.com/blog)<br>
20 Interview: [http://techzinglive.com/?p=227](http://techzinglive.com/?p=227)<br>
8e55f054 »
2012-03-05 added quick description and link regarding PubNub Cryptography and Ci…
21
22
3149403f »
2012-07-06 Readme revisions.
23 #Using Encryption with PubNub
24 For higher security applications, PubNub provides SSL and AES-based encryption features to help safeguard your data. Additional information and higher-level overviews of [Cross-Platform AES Symmetric Key Encryption](http://www.google.com/url?q=http%3A%2F%2Fblog.pubnub.com%2Fpubnub-adds-cross-platform-aes-symmetric-key-encryption%2F&sa=D&sntz=1&usg=AFQjCNF3tjXOJ99EIJLMM-_2Vapd2NJElQ) in general can be found in our blog post. A lower level diagram which details the [PubNub encryption-communication flow can be found here](http://www.google.com/url?q=http%3A%2F%2Fblog.pubnub.com%2Fwp-content%2Fuploads%2F2012%2F07%2FPubNubACLForPublishAndSubscribeRealTimeSystems-6.png&sa=D&sntz=1&usg=AFQjCNGA908A_y0YNRWU1HQ6XE_K0E4Jrw).
25 ##HTTPS (SSL) 2048-bit Encryption
26 HTTPS is recommended for the highest level of security for REST requests to PubNub. Using REST over HTTPS is not required – however, for secure communication, you should make sure the client or REST toolkit you're using is configured to use SSL. The PubNub Cloud service will continue to support both HTTP and HTTPS.
27 ##AES Encryption
28 To enable AES encryption, instantiate a PubNub instance with the presence of the optional cipher_key attribute. The instance will use the value of the cipher_key attribute as the cipher key.
29 ##Message Signing with HMAC/SHA256
30 If the client is publishing, you must also include the secret_key attribute when instantiating the PubNub instance. If the client will only be subscribing, you do not need to include the secret_key attribute. The instance will use the value of the secret_key as the key to sign the message.
31 ##Secure Key Exchange
32 The exchange of the cipher key (and if the client is publishing, the secret key) must occur using a secure communication system, external to PubNub, in order to maintain secrecy of the keys.
8e55f054 »
2012-03-05 added quick description and link regarding PubNub Cryptography and Ci…
33
3149403f »
2012-07-06 Readme revisions.
34 For an example of using encryption with the PubNub JavaScript API, check out the [PubNub Javascript Cryptography Demo](http://www.google.com/url?q=http%3A%2F%2Fpubnub.github.com%2Fpubnub-api%2Fcrypto%2Findex.html&sa=D&sntz=1&usg=AFQjCNE9NvQJbOVu6hn4H-FNirbNxxJyjA) page. The demo shows usage of the Cipher Key + SSL at the same time. There is not exchange however with a central authority server, which is a recommended step for distributing security keys. [This example diagram with illustrate the recommended Central Authority Server model for proper Security Key Exchange](http://www.google.com/url?q=http%3A%2F%2Fblog.pubnub.com%2Fwp-content%2Fuploads%2F2012%2F07%2FPubNubACLForPublishAndSubscribeRealTimeSystems-6.png&sa=D&sntz=1&usg=AFQjCNGA908A_y0YNRWU1HQ6XE_K0E4Jrw).
8e55f054 »
2012-03-05 added quick description and link regarding PubNub Cryptography and Ci…
35
3149403f »
2012-07-06 Readme revisions.
36 #REST API Considerations
37 In addition to platform-specific APIs, PubNub also supports a REST API.
38 ##Mandatory Headers
39 When using the REST API, it is **mandatory** to pass the following HTTP headers to the PubNub server for each request:
8e55f054 »
2012-03-05 added quick description and link regarding PubNub Cryptography and Ci…
40
3149403f »
2012-07-06 Readme revisions.
41 **V**: Version-Number<br>
42 **User-Agent**: NAME-OF-THE-CLIENT-INTERFACE<br>
43 **Accept**: \*/\*<br>
bbe9cdb0 »
2012-03-05 added Socket Pooling Guide to PubNub Client API Doc.
44
3149403f »
2012-07-06 Readme revisions.
45 ###Example Headers###
46 V: 3.1<br>
47 User-Agent: PHP<br>
48 Accept: \*/\*<br>
595c04f5 »
2012-04-10 updated README.md guide for create a PubNub Client.
49
3149403f »
2012-07-06 Readme revisions.
50 ##Selecting a User-agent
27fc4d7d »
2014-03-25 Update README.md
51 Use one of the following User-Agents, based on your client platform, when making a REST-based request: *PHP, JavaScript, Node.JS, Ruby, Ruby-Rhomobile, Python, Python-Twisted, Python-Tornado, C-LibEV, C-LibEvent, C-Qt, VB, C#, Java, Java-Android, Erlang, Titanium, Corona, C-Arduino, C-Unity, C#-Mono, Lua, Obj-C-iOS, C#-WP7, Cocoa, Perl5
Something went wrong with that request. Please try again.