File: wot.py

package info (click to toggle)
python-duniterpy 1.1.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,228 kB
  • sloc: python: 10,624; makefile: 182; sh: 17
file content (346 lines) | stat: -rw-r--r-- 11,614 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
# Copyright  2014-2022 Vincent Texier <vit@free.fr>
#
# DuniterPy is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# DuniterPy is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import logging
from http.client import HTTPResponse

from duniterpy.api.client import RESPONSE_HTTP, Client

logger = logging.getLogger("duniter/wot")

MODULE = "wot"

CERTIFICATIONS_SCHEMA = {
    "type": "object",
    "properties": {
        "pubkey": {"type": "string"},
        "uid": {"type": "string"},
        "isMember": {"type": "boolean"},
        "certifications": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "pubkey": {"type": "string"},
                    "uid": {"type": "string"},
                    "cert_time": {
                        "type": "object",
                        "properties": {
                            "block": {"type": "number"},
                            "medianTime": {"type": "number"},
                        },
                        "required": ["block", "medianTime"],
                    },
                    "sigDate": {"type": "string"},
                    "written": {
                        "oneOf": [
                            {
                                "type": "object",
                                "properties": {
                                    "number": {"type": "number"},
                                    "hash": {"type": "string"},
                                },
                                "required": ["number", "hash"],
                            },
                            {"type": "null"},
                        ]
                    },
                    "isMember": {"type": "boolean"},
                    "wasMember": {"type": "boolean"},
                    "signature": {"type": "string"},
                },
                "required": [
                    "pubkey",
                    "uid",
                    "cert_time",
                    "sigDate",
                    "written",
                    "wasMember",
                    "isMember",
                    "signature",
                ],
            },
        },
    },
    "required": ["pubkey", "uid", "isMember", "certifications"],
}

MEMBERS_SCHEMA = {
    "type": "object",
    "properties": {
        "results": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {"pubkey": {"type": "string"}},
                "required": ["pubkey"],
            },
        }
    },
    "required": ["results"],
}

REQUIREMENTS_SCHEMA = {
    "type": "object",
    "properties": {
        "identities": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "pubkey": {"type": "string"},
                    "uid": {"type": "string"},
                    "meta": {
                        "type": "object",
                        "properties": {"timestamp": {"type": "string"}},
                        "required": ["timestamp"],
                    },
                    "outdistanced": {"type": "boolean"},
                    "certifications": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "from": {"type": "string"},
                                "to": {"type": "string"},
                                "expiresIn": {"type": "number"},
                            },
                            "required": ["from", "to", "expiresIn"],
                        },
                    },
                    "membershipPendingExpiresIn": {"type": "number"},
                    "membershipExpiresIn": {"type": "number"},
                    "wasMember": {"type": "boolean"},
                    "isSentry": {"type": "boolean"},
                    "revoked": {"type": "boolean"},
                    "revokation_sig": {"type": ["string", "null"]},
                    "revoked_on": {"type": ["number", "null"]},
                },
                "required": [
                    "pubkey",
                    "uid",
                    "meta",
                    "outdistanced",
                    "certifications",
                    "membershipPendingExpiresIn",
                    "membershipExpiresIn",
                    "wasMember",
                    "isSentry",
                    "revoked",
                    "revoked_on",
                    "revocation_sig",
                ],
            },
        }
    },
    "required": ["identities"],
}

LOOKUP_SCHEMA = {
    "type": "object",
    "definitions": {
        "meta_data": {"type": "object", "properties": {"timestamp": {"type": "string"}}}
    },
    "properties": {
        "partial": {"type": "boolean"},
        "results": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "pubkey": {"type": "string"},
                    "uids": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "uid": {"type": "string"},
                                "meta": {"$ref": "#/definitions/meta_data"},
                                "self": {"type": "string"},
                                "revocation_sig": {"type": ["string", "null"]},
                                "revoked_on": {"type": ["number", "null"]},
                                "revoked": {"type": "boolean"},
                                "others": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "properties": {
                                            "pubkey": {"type": "string"},
                                            "meta": {"$ref": "#/definitions/meta_data"},
                                            "signature": {"type": "string"},
                                        },
                                    },
                                },
                            },
                            "required": [
                                "uid",
                                "meta",
                                "self",
                                "revocation_sig",
                                "revoked",
                                "others",
                            ],
                        },
                    },
                    "signed": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "uid": {"type": "string"},
                                "pubkey": {"type": "string"},
                                "meta": {"$ref": "#/definitions/meta_data"},
                                "signature": {"type": "string"},
                                "revocation_sig": {"type": ["string", "null"]},
                                "revoked_on": {"type": ["number", "null"]},
                                "revoked": {"type": "boolean"},
                            },
                            "required": ["uid", "pubkey", "meta", "signature"],
                        },
                    },
                },
            },
        },
    },
    "required": ["partial", "results"],
}

IDENTITY_OF_SCHEMA = {
    "type": "object",
    "properties": {
        "pubkey": {"type": "string"},
        "uid": {"type": "string"},
        "sigDate": {"type": "string"},
    },
}


def add(client: Client, identity_signed_raw: str) -> HTTPResponse:
    """
    POST identity raw document

    :param client: Client to connect to the api
    :param identity_signed_raw: Identity raw document
    :return:
    """
    return client.post(
        f"{MODULE}/add", {"identity": identity_signed_raw}, rtype=RESPONSE_HTTP
    )


def certify(client: Client, certification_signed_raw: str) -> HTTPResponse:
    """
    POST certification raw document

    :param client: Client to connect to the api
    :param certification_signed_raw: Certification raw document
    :return:
    """
    return client.post(
        f"{MODULE}/certify", {"cert": certification_signed_raw}, rtype=RESPONSE_HTTP
    )


def revoke(client: Client, revocation_signed_raw: str) -> HTTPResponse:
    """
    POST revocation document

    :param client: Client to connect to the api
    :param revocation_signed_raw: Certification raw document
    :return:
    """
    return client.post(
        f"{MODULE}/revoke",
        {"revocation": revocation_signed_raw},
        rtype=RESPONSE_HTTP,
    )


def lookup(client: Client, search: str) -> dict:
    """
    GET UID/Public key data

    :param client: Client to connect to the api
    :param search: UID or public key
    :return:
    """
    return client.get(f"{MODULE}/lookup/{search}", schema=LOOKUP_SCHEMA)


def certifiers_of(client: Client, search: str) -> dict:
    """
    GET UID/Public key certifiers

    :param client: Client to connect to the api
    :param search: UID or public key
    :return:
    """
    return client.get(f"{MODULE}/certifiers-of/{search}", schema=CERTIFICATIONS_SCHEMA)


def certified_by(client: Client, search: str) -> dict:
    """
    GET identities certified by UID/Public key

    :param client: Client to connect to the api
    :param search: UID or public key
    :return:
    """
    return client.get(f"{MODULE}/certified-by/{search}", schema=CERTIFICATIONS_SCHEMA)


def members(client: Client) -> dict:
    """
    GET list of all current members of the Web of Trust

    :param client: Client to connect to the api
    :return:
    """
    return client.get(f"{MODULE}/members", schema=MEMBERS_SCHEMA)


def requirements(client: Client, search: str) -> dict:
    """
    GET list of requirements for a given UID/Public key

    :param client: Client to connect to the api
    :param search: UID or public key
    :return:
    """
    return client.get(f"{MODULE}/requirements/{search}", schema=REQUIREMENTS_SCHEMA)


def requirements_of_pending(client: Client, minsig: int) -> dict:
    """
    GET list of requirements of all pending identities with a minimum of minsig certifications

    :param client: Client to connect to the api
    :param minsig: Minimum number of certifications
    :return:
    """
    return client.get(
        f"{MODULE}/requirements-of-pending/{minsig}", schema=REQUIREMENTS_SCHEMA
    )


def identity_of(client: Client, search: str) -> dict:
    """
    GET Identity data written in the blockchain

    :param client: Client to connect to the api
    :param search: UID or public key
    :return:
    """
    return client.get(f"{MODULE}/identity-of/{search}", schema=IDENTITY_OF_SCHEMA)