Skip to content

Commit c35755e

Browse files
diagprovdiagprov
committed
Open Source
1 parent 8254325 commit c35755e

File tree

3 files changed

+206
-180
lines changed

3 files changed

+206
-180
lines changed

‎LICENSE

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

‎README.md

+3-180
Original file line numberDiff line numberDiff line change
@@ -1,182 +1,5 @@
1-
# Testing Tool e4clic
1+
![alt text](logo.png)
22

3-
e4clic is a Linux command-line testing tool for E4 clients.
4-
5-
The basic E4 C client functionality is provided by `e4client.c` and
6-
`e4client.h`. These components are designed to be lightweight and
7-
are shared across platform.
8-
9-
They are only dependant on SHA3 and AES256-SIV implementation, which
10-
use an interfaces defined in `crypto/
11-
in `mro.c` and `mro.h`, for which size-optimized versions exist for low-end
12-
embedded targets.
13-
14-
This version of E4C uses the PAHO MQTT C Client library
15-
for networking.
16-
17-
18-
## Build Dependencies
19-
20-
A `Makefile` is provided for building the `e4clic` command line tool.
21-
22-
You can take care of most build requirements in an Ubuntu system with
23-
`sudo apt install gcc make cmake gcc libssl-dev`
24-
25-
The only external build dependency is for the Paho MQTT C Client Library, or
26-
more specifically the `MQTTClient.h` header file and `libpaho-mqtt3c`
27-
library file. See the project homepage at https://www.eclipse.org/paho/clients/c/ and github sources at https://github.com/eclipse/paho.mqtt.c
28-
29-
You may install the libraries system-wide or you may use the provided
30-
`build_paho-mqtt3c.sh` script to fetch the library, compile it, and
31-
a provide symbolic link to the static library.
32-
33-
34-
## Usage
35-
36-
The utility is invoked with two command line parameters:
37-
```
38-
e4clic <Broker> <ClientId>
39-
```
40-
The first parameter to e4clic is the location for MQTT broker,
41-
typically located on port 1883, and second parameter is the client id
42-
for this particular host.
43-
```
44-
$ ./e4clic tcp://test.mosquitto.org:1883 Alice
45-
!!! broker = tcp://test.mosquitto.org:1883
46-
!!! my client id = Alice
47-
Alice.e4p: No such file or directory
48-
!!! Persistence file set to Alice.e4p
49-
!!! key for e4/Alice zeroized
50-
!!! command topic = e4/Alice
51-
```
52-
Note that a persistence file `Alice.e4p` is created in current directory.
53-
This contains all keys that the "Alice" client knows and will be loaded
54-
in subsequent invocations unless you delete it.
55-
The test client has a bunch of single-letter commands prefixed with
56-
exclamation mark (`!`):
57-
```
58-
?
59-
--- e4clic has single-letter commands prefixed with '!'
60-
--- <message> Broadcast message to current topic.
61-
--- !t <topic> Change current topic.
62-
--- !s <topics> Subscribe (and change current) to topics.
63-
--- !u <topics> Unsubscribe from topics.
64-
--- !z <clients> Locally zeroise (set to default) Client's IdKey.
65-
--- !0 <clients> Send RemoveTopic(current) command.
66-
--- !1 <clients> Send ResetTopics() command.
67-
--- !2 <key> <clients> Send SetIdKey(key) command.
68-
--- !3 <key> <clients> Send SetTopicKey(current, key).
69-
--- !l Dump all topic keys.
70-
--- !x or !q Disconnect and quit.
71-
```
72-
73-
## Tutorial
74-
75-
We will illustrate basic usage logic of e4clic with these examples.
76-
77-
### Exchanging messages
78-
79-
Let's establish two clients, "Alice" and "Bob" and subscribe them to topic
80-
`/hello` with `!s` command:
81-
82-
```
83-
$ ./e4clic tcp://test.mosquitto.org:1883 Alice
84-
!!! broker = tcp://test.mosquitto.org:1883
85-
!!! my client id = Alice
86-
Alice.e4p: No such file or directory
87-
!!! Persistence file set to Alice.e4p
88-
!!! key for e4/Alice zeroized
89-
!!! command topic = e4/Alice
90-
!s /hello
91-
!!! Subscribed to /hello
92-
```
93-
On second window
94-
```
95-
./e4clic tcp://test.mosquitto.org:1883 Bob
96-
!!! broker = tcp://test.mosquitto.org:1883
97-
!!! my client id = Bob
98-
Bob.e4p: No such file or directory
99-
!!! Persistence file set to Bob.e4p
100-
!!! key for e4/Bob zeroized
101-
!!! command topic = e4/Bob
102-
!s /hello
103-
!!! Subscribed to /hello
104-
105-
```
106-
Now, if you enter a line of text (without `!`), it will be broadcast on the
107-
topic `/hello` without encryption, as encryption keys are not set:
108-
```
109-
Hello, World!
110-
>>> (!-105) /hello:
111-
000 Hello, World! 48 65 6C 6C 6F 2C 20 57 6F 72 6C 64 21
112-
<<< (!-104) /hello:
113-
000 Hello, World! 48 65 6C 6C 6F 2C 20 57 6F 72 6C 64 21
114-
```
115-
The fist debug line indicates a sent message (`>>>`), and error 105,
116-
TopicKeyMissing. Both clients receive the message (`<<<`) with error 104,
117-
indicating that the message is too short to be encrypted.
118-
119-
### Setting Topic Keys
120-
121-
By default the command channel key is set to to all zeros, which can be
122-
easily verified with `!l` command. In case of Alice:
123-
```
124-
!l
125-
!!! 0 topic hash = C8BB7B9AA30C7322C6F0A894699FBD2917E371CB60973AFA9FFA37C7AF6877FF
126-
!!! 0 topic key = 00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
127-
```
128-
We will use the `!z` command to make Alice aware of Bob's zero command key
129-
```
130-
!z Bob
131-
```
132-
This does not create any traffic, but the other client command key is
133-
now visible via `!l`. We can now set topic key for current topic (previously
134-
set to `/hello`)
135-
with
136-
```
137-
!3 key Bob
138-
```
139-
A sha3("key") is set both locally and on remote machine for the current
140-
topic (set via `!t` or `!s`).
141-
```
142-
!!! SetTopicKey(/hello, 99B0188470D1F47F4CA39B9964A97E78644B2E103CAA35EB918AB6494E0F0626F994D5AE441D017F8010252A805B50E646D5D5676B752D45477C34182F59D632) -> e4/Bob
143-
>>> (ok) e4/Bob:
144-
000 Y{<[....;*.X.J.= 59 7B 3C 5B 00 00 00 00 3B 2A 15 58 80 4A 95 3D
145-
010 W.J&.....jk...r. 57 19 4A 26 04 90 0D A7 7F 6A 6B A2 A9 96 72 9A
146-
020 H.G.u...r.G.A..Y 48 DC 47 92 75 BB 9D 8F 72 8D 47 CD 41 CB 9A 59
147-
030 ......s9;f..5..& B8 E7 85 81 AA 1E 73 39 3B 66 A6 F9 35 B0 9E 26
148-
040 .!.7.r...;..j... 9F 21 B3 37 C7 72 AC ED EB 3B E9 83 6A 12 C3 8C
149-
050 ..0.\......jT.f. D2 89 30 BC 5C 09 F1 FD FD EB DD 6A 54 CF 66 86
150-
060 ...g.S..q..B..Y# A5 06 F2 67 DD 53 D9 08 71 D7 E2 42 E1 B8 59 23
151-
070 .....1... C8 FA D0 BF BB 31 B8 05 CF
152-
```
153-
We may now broadcast and receive encrypted messages:
154-
```
155-
hello
156-
>>> (ok) /hello:
157-
000 ..<[.....})..1.. 87 7F 3C 5B 00 00 00 00 FE 7D 29 DC A8 31 AE 0D
158-
010 .mE.v....j.3. C1 6D 45 83 76 CE EC 9B F6 6A D3 33 AE
159-
<<< (ok) /hello:
160-
000 hello 68 65 6C 6C 6F
161-
```
162-
We can see the ciphertext and that the current client also receives and decrypts its own message.
163-
164-
165-
### Setting Client ID Keys
166-
167-
We Alice can set the command key for Bob (assuming that she knows the previous one -- typically zero if `!z Bob` is called):
168-
169-
```
170-
!2 bobkey Bob
171-
!!! SetIdKey(FFA50B52DB77E2D4535B2E1FA846B14A89DF142802865BBFA8CCEC39EC35E13120EA8D2B16C9BAD7B2F513A6E851F7BE5EB97769D40832136810BF6987815E9F) -> e4/Bob
172-
>>> (ok) e4/Bob:
173-
000 ..<[....K....W.c BF 7F 3C 5B 00 00 00 00 4B AE E7 83 B5 57 0C 63
174-
010 Nv..u'..Y.\..g!@ 4E 76 CD EB 75 27 06 8D 59 CE 5C 2E A8 67 21 40
175-
020 ....#qi*.e0...T. 06 B0 94 90 23 71 69 2A 9D 65 30 8B FC E8 54 F9
176-
030 Uu.....R..vlv.yr 55 75 CF 96 BA C7 E8 52 92 84 76 6C 76 E1 79 72
177-
040 J._....9vTc.+..M 4A CF 5F 14 B5 FD EF 39 76 54 63 0A 2B CC DE 4D
178-
050 ..\;....E F9 9E 5C 3B 2E 89 C7 AD 45
179-
```
180-
181-
This can be repeated a number of times, each time the key replaces the previous one, which can be verified with `!l`
3+
# Introduction
1824

5+
This is a work in progress C-client that consumes libe4.

‎logo.png

10.8 KB
Loading

0 commit comments

Comments
 (0)