libsm 0.6.0

A Rust Library of China's Standards of Encryption Algorithms (SM2/3/4)
Documentation 
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

// Copyright 2018 Cryptape Technology LLC.
//
// 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.

use std::fmt::Display;
use std::fmt::Formatter;

pub type Sm2Result<T> = Result<T, Sm2Error>;

#[derive(PartialEq)]
pub enum Sm2Error {
    NotOnCurve,
    FieldSqrtError,
    InvalidDer,
    InvalidPublic,
    InvalidPrivate,
    ZeroDivisor,
    ZeroPoint,
    InvalidPoint,
    CheckPointErr,
    ZeroData,
    HashNotEqual,
    IdTooLong,
    ZeroFiled,
    InvalidFieldLen,
    ZeroSig,
    InvalidDigestLen,
    InvalidSecretKey,
}

impl ::std::fmt::Debug for Sm2Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> ::std::fmt::Result {
        write!(f, "{self}")
    }
}

impl From<Sm2Error> for &str {
    fn from(e: Sm2Error) -> Self {
        match e {
            Sm2Error::NotOnCurve => "the point not on curve",
            Sm2Error::FieldSqrtError => "field elem sqrt error",
            Sm2Error::InvalidDer => "invalid der",
            Sm2Error::InvalidPublic => "invalid public key",
            Sm2Error::InvalidPrivate => "invalid private key",
            Sm2Error::ZeroDivisor => "zero has no inversion",
            Sm2Error::ZeroPoint => "cannot convert the infinite point to affine",
            Sm2Error::InvalidPoint => "invalid jacobian point",
            Sm2Error::CheckPointErr => "check point error",
            Sm2Error::ZeroData => "the vector is zero",
            Sm2Error::HashNotEqual => "hash not equal",
            Sm2Error::IdTooLong => "ID is too long",
            Sm2Error::ZeroFiled => "zero has no inversion in filed",
            Sm2Error::InvalidFieldLen => "a SCA-256 field element must be 32-byte long",
            Sm2Error::ZeroSig => "the signature is zero, cannot sign",
            Sm2Error::InvalidDigestLen => "the length of digest must be 32-bytes",
            Sm2Error::InvalidSecretKey => "invalid secret key",
        }
    }
}

impl Display for Sm2Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let err_msg = match self {
            Sm2Error::NotOnCurve => "the point not on curve",
            Sm2Error::FieldSqrtError => "field elem sqrt error",
            Sm2Error::InvalidDer => "invalid der",
            Sm2Error::InvalidPublic => "invalid public key",
            Sm2Error::InvalidPrivate => "invalid private key",
            Sm2Error::ZeroDivisor => "zero has no inversion",
            Sm2Error::ZeroPoint => "cannot convert the infinite point to affine",
            Sm2Error::InvalidPoint => "invalid jacobian point",
            Sm2Error::CheckPointErr => "check point error",
            Sm2Error::ZeroData => "the vector is zero",
            Sm2Error::HashNotEqual => "hash and cipher not equal",
            Sm2Error::IdTooLong => "ID is too long",
            Sm2Error::ZeroFiled => "zero has no inversion in filed",
            Sm2Error::InvalidFieldLen => "a SCA-256 field element must be 32-byte long",
            Sm2Error::ZeroSig => "the signature is zero, cannot sign",
            Sm2Error::InvalidDigestLen => "the length of digest must be 32-bytes",
            Sm2Error::InvalidSecretKey => "invalid secret key",
        };
        write!(f, "{err_msg}")
    }
}

#[cfg(test)]
mod tests {
    use super::Sm2Error;

    #[test]
    fn test_error_display() {
        let e = Sm2Error::InvalidPublic;
        assert_eq!(format!("{e}"), "invalid public key");
        assert_eq!(format!("{e:?}"), "invalid public key");
    }
}