4276bb8fe248f5d86301482b032dd3debe50b836
[leap_pycommon.git] / src / leap / common / events / events.proto
1 // signal.proto
2 // Copyright (C) 2013 LEAP
3 //
4 // This program is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
16
17 package leap.common.events;
18 option py_generic_services = true;
19
20
21 // These are the events that can be signaled using the events mechanism.
22
23 enum Event {
24   CLIENT_SESSION_ID = 1;
25   CLIENT_UID = 2;
26   SOLEDAD_CREATING_KEYS = 3;
27   SOLEDAD_DONE_CREATING_KEYS = 4;
28   SOLEDAD_UPLOADING_KEYS = 5;
29   SOLEDAD_DONE_UPLOADING_KEYS = 6;
30   SOLEDAD_DOWNLOADING_KEYS = 7;
31   SOLEDAD_DONE_DOWNLOADING_KEYS = 8;
32   SOLEDAD_NEW_DATA_TO_SYNC = 9;
33   SOLEDAD_DONE_DATA_SYNC = 10;
34   UPDATER_NEW_UPDATES = 11;
35   UPDATER_DONE_UPDATING = 12;
36   RAISE_WINDOW = 13;
37   SMTP_SERVICE_STARTED = 14;
38   SMTP_SERVICE_FAILED_TO_START = 15;
39   SMTP_RECIPIENT_ACCEPTED_ENCRYPTED = 16;
40   SMTP_RECIPIENT_ACCEPTED_UNENCRYPTED = 17;
41   SMTP_RECIPIENT_REJECTED = 18;
42   SMTP_START_ENCRYPT_AND_SIGN = 19;
43   SMTP_END_ENCRYPT_AND_SIGN = 20;
44   SMTP_START_SIGN = 21;
45   SMTP_END_SIGN = 22;
46   SMTP_SEND_MESSAGE_START = 23;
47   SMTP_SEND_MESSAGE_SUCCESS = 24;
48   SMTP_SEND_MESSAGE_ERROR = 25;
49   SMTP_CONNECTION_LOST = 26;
50   IMAP_SERVICE_STARTED = 30;
51   IMAP_SERVICE_FAILED_TO_START = 31;
52   IMAP_CLIENT_LOGIN = 32;
53   IMAP_FETCHED_INCOMING = 33;
54   IMAP_MSG_PROCESSING = 34;
55   IMAP_MSG_DECRYPTED = 35;
56   IMAP_MSG_SAVED_LOCALLY = 36;
57   IMAP_MSG_DELETED_INCOMING = 37;
58   IMAP_UNHANDLED_ERROR = 38;
59   KEYMANAGER_LOOKING_FOR_KEY = 40;
60   KEYMANAGER_KEY_FOUND = 41;
61   KEYMANAGER_KEY_NOT_FOUND = 42;
62   KEYMANAGER_STARTED_KEY_GENERATION = 43;
63   KEYMANAGER_FINISHED_KEY_GENERATION = 44;
64   KEYMANAGER_DONE_UPLOADING_KEYS = 45;
65 }
66
67
68 // A SignalRequest is the type of the message sent from one component to request
69 // that a signal be sent to every registered component.
70
71 message SignalRequest {
72   required Event event = 1;
73   required string content = 2;
74   required string mac_method = 3;
75   required bytes mac = 4;
76   optional string enc_method = 5;
77   optional bool error_occurred = 6;
78 }
79
80
81 // A RegisterRequest message tells the server that a component wants to
82 // be signaled whenever a specific event occurs.
83
84 message RegisterRequest {
85   required Event event = 1;
86   required int32 port = 2;
87   required string mac_method = 3;
88   required bytes mac = 4;
89 }
90
91
92 // An UnregisterRequest message tells the server that a component does not
93 // want to be signaled when a specific event occurs.
94
95 message UnregisterRequest {
96   required Event event = 1;
97   required int32 port = 2;
98   required string mac_method = 3;
99   required bytes mac = 4;
100 }
101
102
103 // A PingRequest message is used to find out if a server or component is
104 // alive.
105
106 message PingRequest {
107 }
108
109
110 // The EventResponse is the message sent back by server and components after
111 // they receive other kinds of requests.
112
113 message EventResponse {
114
115   enum Status {
116     OK = 1;
117     UNAUTH = 2;
118     ERROR = 3;
119   }
120
121   required Status status = 1;
122   optional string result = 2;
123 }
124
125
126 // The EventsServerService is the service provided by the server.
127
128 service EventsServerService {
129   rpc ping(PingRequest) returns (EventResponse);
130   rpc register(RegisterRequest) returns (EventResponse);
131   rpc unregister(UnregisterRequest) returns (EventResponse);
132   rpc signal(SignalRequest) returns (EventResponse);
133 }
134
135
136 // EventsComponentService is the service provided by components (clients).
137
138 service EventsClientService {
139   rpc ping(PingRequest) returns (EventResponse);
140   rpc signal(SignalRequest) returns (EventResponse);
141 }