Browse Source

Add README, licenses and screenshots

master
Danilo Bargen 2 years ago
parent
commit
3d3c913fc0

+ 176
- 0
LICENSE-APACHE View File

@@ -0,0 +1,176 @@
1
+                                 Apache License
2
+                           Version 2.0, January 2004
3
+                        http://www.apache.org/licenses/
4
+
5
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+   1. Definitions.
8
+
9
+      "License" shall mean the terms and conditions for use, reproduction,
10
+      and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+      "Licensor" shall mean the copyright owner or entity authorized by
13
+      the copyright owner that is granting the License.
14
+
15
+      "Legal Entity" shall mean the union of the acting entity and all
16
+      other entities that control, are controlled by, or are under common
17
+      control with that entity. For the purposes of this definition,
18
+      "control" means (i) the power, direct or indirect, to cause the
19
+      direction or management of such entity, whether by contract or
20
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+      outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+      "You" (or "Your") shall mean an individual or Legal Entity
24
+      exercising permissions granted by this License.
25
+
26
+      "Source" form shall mean the preferred form for making modifications,
27
+      including but not limited to software source code, documentation
28
+      source, and configuration files.
29
+
30
+      "Object" form shall mean any form resulting from mechanical
31
+      transformation or translation of a Source form, including but
32
+      not limited to compiled object code, generated documentation,
33
+      and conversions to other media types.
34
+
35
+      "Work" shall mean the work of authorship, whether in Source or
36
+      Object form, made available under the License, as indicated by a
37
+      copyright notice that is included in or attached to the work
38
+      (an example is provided in the Appendix below).
39
+
40
+      "Derivative Works" shall mean any work, whether in Source or Object
41
+      form, that is based on (or derived from) the Work and for which the
42
+      editorial revisions, annotations, elaborations, or other modifications
43
+      represent, as a whole, an original work of authorship. For the purposes
44
+      of this License, Derivative Works shall not include works that remain
45
+      separable from, or merely link (or bind by name) to the interfaces of,
46
+      the Work and Derivative Works thereof.
47
+
48
+      "Contribution" shall mean any work of authorship, including
49
+      the original version of the Work and any modifications or additions
50
+      to that Work or Derivative Works thereof, that is intentionally
51
+      submitted to Licensor for inclusion in the Work by the copyright owner
52
+      or by an individual or Legal Entity authorized to submit on behalf of
53
+      the copyright owner. For the purposes of this definition, "submitted"
54
+      means any form of electronic, verbal, or written communication sent
55
+      to the Licensor or its representatives, including but not limited to
56
+      communication on electronic mailing lists, source code control systems,
57
+      and issue tracking systems that are managed by, or on behalf of, the
58
+      Licensor for the purpose of discussing and improving the Work, but
59
+      excluding communication that is conspicuously marked or otherwise
60
+      designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+      "Contributor" shall mean Licensor and any individual or Legal Entity
63
+      on behalf of whom a Contribution has been received by Licensor and
64
+      subsequently incorporated within the Work.
65
+
66
+   2. Grant of Copyright License. Subject to the terms and conditions of
67
+      this License, each Contributor hereby grants to You a perpetual,
68
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+      copyright license to reproduce, prepare Derivative Works of,
70
+      publicly display, publicly perform, sublicense, and distribute the
71
+      Work and such Derivative Works in Source or Object form.
72
+
73
+   3. Grant of Patent License. Subject to the terms and conditions of
74
+      this License, each Contributor hereby grants to You a perpetual,
75
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+      (except as stated in this section) patent license to make, have made,
77
+      use, offer to sell, sell, import, and otherwise transfer the Work,
78
+      where such license applies only to those patent claims licensable
79
+      by such Contributor that are necessarily infringed by their
80
+      Contribution(s) alone or by combination of their Contribution(s)
81
+      with the Work to which such Contribution(s) was submitted. If You
82
+      institute patent litigation against any entity (including a
83
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+      or a Contribution incorporated within the Work constitutes direct
85
+      or contributory patent infringement, then any patent licenses
86
+      granted to You under this License for that Work shall terminate
87
+      as of the date such litigation is filed.
88
+
89
+   4. Redistribution. You may reproduce and distribute copies of the
90
+      Work or Derivative Works thereof in any medium, with or without
91
+      modifications, and in Source or Object form, provided that You
92
+      meet the following conditions:
93
+
94
+      (a) You must give any other recipients of the Work or
95
+          Derivative Works a copy of this License; and
96
+
97
+      (b) You must cause any modified files to carry prominent notices
98
+          stating that You changed the files; and
99
+
100
+      (c) You must retain, in the Source form of any Derivative Works
101
+          that You distribute, all copyright, patent, trademark, and
102
+          attribution notices from the Source form of the Work,
103
+          excluding those notices that do not pertain to any part of
104
+          the Derivative Works; and
105
+
106
+      (d) If the Work includes a "NOTICE" text file as part of its
107
+          distribution, then any Derivative Works that You distribute must
108
+          include a readable copy of the attribution notices contained
109
+          within such NOTICE file, excluding those notices that do not
110
+          pertain to any part of the Derivative Works, in at least one
111
+          of the following places: within a NOTICE text file distributed
112
+          as part of the Derivative Works; within the Source form or
113
+          documentation, if provided along with the Derivative Works; or,
114
+          within a display generated by the Derivative Works, if and
115
+          wherever such third-party notices normally appear. The contents
116
+          of the NOTICE file are for informational purposes only and
117
+          do not modify the License. You may add Your own attribution
118
+          notices within Derivative Works that You distribute, alongside
119
+          or as an addendum to the NOTICE text from the Work, provided
120
+          that such additional attribution notices cannot be construed
121
+          as modifying the License.
122
+
123
+      You may add Your own copyright statement to Your modifications and
124
+      may provide additional or different license terms and conditions
125
+      for use, reproduction, or distribution of Your modifications, or
126
+      for any such Derivative Works as a whole, provided Your use,
127
+      reproduction, and distribution of the Work otherwise complies with
128
+      the conditions stated in this License.
129
+
130
+   5. Submission of Contributions. Unless You explicitly state otherwise,
131
+      any Contribution intentionally submitted for inclusion in the Work
132
+      by You to the Licensor shall be under the terms and conditions of
133
+      this License, without any additional terms or conditions.
134
+      Notwithstanding the above, nothing herein shall supersede or modify
135
+      the terms of any separate license agreement you may have executed
136
+      with Licensor regarding such Contributions.
137
+
138
+   6. Trademarks. This License does not grant permission to use the trade
139
+      names, trademarks, service marks, or product names of the Licensor,
140
+      except as required for reasonable and customary use in describing the
141
+      origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+   7. Disclaimer of Warranty. Unless required by applicable law or
144
+      agreed to in writing, Licensor provides the Work (and each
145
+      Contributor provides its Contributions) on an "AS IS" BASIS,
146
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+      implied, including, without limitation, any warranties or conditions
148
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+      PARTICULAR PURPOSE. You are solely responsible for determining the
150
+      appropriateness of using or redistributing the Work and assume any
151
+      risks associated with Your exercise of permissions under this License.
152
+
153
+   8. Limitation of Liability. In no event and under no legal theory,
154
+      whether in tort (including negligence), contract, or otherwise,
155
+      unless required by applicable law (such as deliberate and grossly
156
+      negligent acts) or agreed to in writing, shall any Contributor be
157
+      liable to You for damages, including any direct, indirect, special,
158
+      incidental, or consequential damages of any character arising as a
159
+      result of this License or out of the use or inability to use the
160
+      Work (including but not limited to damages for loss of goodwill,
161
+      work stoppage, computer failure or malfunction, or any and all
162
+      other commercial damages or losses), even if such Contributor
163
+      has been advised of the possibility of such damages.
164
+
165
+   9. Accepting Warranty or Additional Liability. While redistributing
166
+      the Work or Derivative Works thereof, You may choose to offer,
167
+      and charge a fee for, acceptance of support, warranty, indemnity,
168
+      or other liability obligations and/or rights consistent with this
169
+      License. However, in accepting such obligations, You may act only
170
+      on Your own behalf and on Your sole responsibility, not on behalf
171
+      of any other Contributor, and only if You agree to indemnify,
172
+      defend, and hold each Contributor harmless for any liability
173
+      incurred by, or claims asserted against, such Contributor by reason
174
+      of your accepting any such warranty or additional liability.
175
+
176
+   END OF TERMS AND CONDITIONS

+ 19
- 0
LICENSE-MIT View File

@@ -0,0 +1,19 @@
1
+Copyright (c) 2016 Threema GmbH
2
+
3
+Permission is hereby granted, free of charge, to any person obtaining a copy
4
+of this software and associated documentation files (the "Software"), to deal
5
+in the Software without restriction, including without limitation the rights
6
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+copies of the Software, and to permit persons to whom the Software is
8
+furnished to do so, subject to the following conditions:
9
+
10
+The above copyright notice and this permission notice shall be included in all
11
+copies or substantial portions of the Software.
12
+
13
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+SOFTWARE.

+ 40
- 1
README.md View File

@@ -1,4 +1,43 @@
1 1
 # SaltyRTC Demo
2 2
 
3 3
 Small demo application with a web interface and an Android app that communicate
4
-over WebRTC.
4
+over the signaling channel as well as via WebRTC.
5
+
6
+<img src="web/screenshot.png" height="500">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="android/screenshot.png" height="500">
7
+
8
+## Usage
9
+
10
+### Web
11
+
12
+Install dependencies:
13
+
14
+    $ npm install
15
+
16
+First, adjust the `HOST` and `PORT` variables in the `scripts.js` file and
17
+point them to a [SaltyRTC server][server] instance. Then simply open
18
+`index.html` in a modern web browser with support for WebRTC and ES2015.
19
+
20
+### Android
21
+
22
+Make sure that the Android SDK is installed and configured properly.
23
+
24
+Then, adjust the `HOST` and `PORT` variables in the
25
+`app/src/main/java/org/saltyrtc/demo/app/Config.java` directory and point them
26
+to a [SaltyRTC server][server] instance.
27
+
28
+Finally, connect an Android 5.0+ device with USB debugging enabled to your
29
+computer and run the following command:
30
+
31
+    $ ./gradlew assembleDebug installDebug
32
+
33
+
34
+## License
35
+
36
+    Copyright (c) 2016 Threema GmbH
37
+
38
+    Licensed under the Apache License, Version 2.0, <see LICENSE-APACHE file>
39
+    or the MIT license <see LICENSE-MIT file>, at your option. This file may not be
40
+    copied, modified, or distributed except according to those terms.
41
+
42
+
43
+[server]: https://github.com/saltyrtc/saltyrtc-server-python "SaltyRTC Server"

+ 7
- 0
android/app/src/main/java/org/saltyrtc/demo/app/Config.java View File

@@ -1,3 +1,10 @@
1
+/*
2
+ * Copyright (c) 2016 Threema GmbH
3
+ *
4
+ * Licensed under the Apache License, Version 2.0, <see LICENSE-APACHE file>
5
+ * or the MIT license <see LICENSE-MIT file>, at your option. This file may not be
6
+ * copied, modified, or distributed except according to those terms.
7
+ */
1 8
 package org.saltyrtc.demo.app;
2 9
 
3 10
 public class Config {

+ 7
- 0
android/app/src/main/java/org/saltyrtc/demo/app/MainActivity.java View File

@@ -1,3 +1,10 @@
1
+/*
2
+ * Copyright (c) 2016 Threema GmbH
3
+ *
4
+ * Licensed under the Apache License, Version 2.0, <see LICENSE-APACHE file>
5
+ * or the MIT license <see LICENSE-MIT file>, at your option. This file may not be
6
+ * copied, modified, or distributed except according to those terms.
7
+ */
1 8
 package org.saltyrtc.demo.app;
2 9
 
3 10
 import android.annotation.SuppressLint;

+ 7
- 0
android/app/src/main/java/org/saltyrtc/demo/app/StateType.java View File

@@ -1,3 +1,10 @@
1
+/*
2
+ * Copyright (c) 2016 Threema GmbH
3
+ *
4
+ * Licensed under the Apache License, Version 2.0, <see LICENSE-APACHE file>
5
+ * or the MIT license <see LICENSE-MIT file>, at your option. This file may not be
6
+ * copied, modified, or distributed except according to those terms.
7
+ */
1 8
 package org.saltyrtc.demo.app;
2 9
 
3 10
 public enum StateType {

+ 7
- 0
android/app/src/main/java/org/saltyrtc/demo/app/WebRTC.java View File

@@ -1,3 +1,10 @@
1
+/*
2
+ * Copyright (c) 2016 Threema GmbH
3
+ *
4
+ * Licensed under the Apache License, Version 2.0, <see LICENSE-APACHE file>
5
+ * or the MIT license <see LICENSE-MIT file>, at your option. This file may not be
6
+ * copied, modified, or distributed except according to those terms.
7
+ */
1 8
 package org.saltyrtc.demo.app;
2 9
 
3 10
 import android.util.Log;

BIN
android/screenshot.png View File


+ 7
- 0
web/index.html View File

@@ -1,4 +1,11 @@
1 1
 <!doctype html>
2
+<!--
3
+    Copyright (c) 2016 Threema GmbH
4
+
5
+    Licensed under the Apache License, Version 2.0, <see LICENSE-APACHE file>
6
+    or the MIT license <see LICENSE-MIT file>, at your option. This file may not be
7
+    copied, modified, or distributed except according to those terms.
8
+-->
2 9
 <html>
3 10
     <head>
4 11
         <title>SaltyRTC Demo</title>

BIN
web/screenshot.png View File


+ 9
- 0
web/scripts.js View File

@@ -1,3 +1,12 @@
1
+/**
2
+ * Copyright (c) 2016 Threema GmbH
3
+ *
4
+ * Licensed under the Apache License, Version 2.0, <see LICENSE-APACHE file>
5
+ * or the MIT license <see LICENSE-MIT file>, at your option. This file may not be
6
+ * copied, modified, or distributed except according to those terms.
7
+ */
8
+
9
+// Note: NEVER use those exact keys in production!
1 10
 const PUBLIC_KEY = '424280166304526b4a2874a2270d091071fcc5c98959f7d4718715626df26204';
2 11
 const PRIVATE_KEY = '74d427ae6a95dedde68850e0ff9da952acf69e6e41436230f126fbd220e1faea';
3 12
 const TRUSTED_KEY = '232385faea4c0fca2c867bfb7ca74f634178ee0bc13364ee738e02cd4318e839';

+ 8
- 0
web/utils.js View File

@@ -1,3 +1,11 @@
1
+/**
2
+ * Copyright (c) 2016 Threema GmbH
3
+ *
4
+ * Licensed under the Apache License, Version 2.0, <see LICENSE-APACHE file>
5
+ * or the MIT license <see LICENSE-MIT file>, at your option. This file may not be
6
+ * copied, modified, or distributed except according to those terms.
7
+ */
8
+
1 9
 function hexToU8a(hexstring) {
2 10
     let array, i, j, k, ref;
3 11
     j = 0;

Loading…
Cancel
Save