File: types.py

package info (click to toggle)
python-signedjson 1.1.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 192 kB
  • sloc: python: 375; makefile: 3
file content (65 lines) | stat: -rw-r--r-- 1,791 bytes parent folder | download
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
# -*- coding: utf-8 -*-
# Copyright 2020 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import sys
from typing import TYPE_CHECKING

import nacl.signing

if TYPE_CHECKING or sys.version_info < (3, 8, 0):
    from typing_extensions import Protocol
else:
    from typing import Protocol


class BaseKey(Protocol):
    """Common base type for VerifyKey and SigningKey"""

    version = ""  # type: str
    alg = ""  # type: str

    def __bytes__(self) -> bytes:
        pass

    def encode(self):
        # type: () -> bytes
        pass  # pragma: nocover


class VerifyKey(BaseKey):
    """The public part of a key pair, for use with verify_signed_json"""

    def verify(self, message, signature):
        # type: (bytes, bytes) -> bytes
        pass  # pragma: nocover


class VerifyKeyWithExpiry(VerifyKey):
    expired: int


class SigningKey(BaseKey):
    """The private part of a key pair, for use with sign_json"""

    def sign(self, message):
        # type: (bytes) -> nacl.signing.SignedMessage
        pass  # pragma: nocover

    @property
    def verify_key(self):
        # Note: use `signedjson.key.get_verify_key` to get a
        # `signedjson.types.VerifyKey`.
        # type: () -> nacl.signing.VerifyKey
        pass  # pragma: nocover