ursa 0.2.0-dev-2

This is the shared crypto library for Hyperledger components.
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

use std::os::raw::{c_char, c_void};

use errors::prelude::*;
use ffi::ErrorCode;

extern crate log;
extern crate time;

use utils::ctypes::*;
use utils::logger::{EnabledCB, FlushCB, HLCryptoDefaultLogger, HLCryptoLogger, LogCB};

/// Set custom logger implementation.
///
/// Allows library user to provide custom logger implementation as set of handlers.
///
/// #Params
/// context: pointer to some logger context that will be available in logger handlers.
/// enabled: (optional) "enabled" operation handler - calls to determines if a log record would be logged. (false positive if not specified)
/// log: "log" operation handler - calls to logs a record.
/// flush: (optional) "flush" operation handler - calls to flushes buffered records (in case of crash or signal).
///
/// #Returns
/// Error code
#[no_mangle]
pub extern "C" fn ursa_set_logger(
    context: *const c_void,
    enabled: Option<EnabledCB>,
    log: Option<LogCB>,
    flush: Option<FlushCB>,
) -> ErrorCode {
    trace!(
        "ursa_set_logger >>> context: {:?}, enabled: {:?}, log: {:?}, flush: {:?}",
        context,
        log,
        enabled,
        flush
    );

    check_useful_c_callback!(log, ErrorCode::CommonInvalidParam3);

    let res = match HLCryptoLogger::init(context, enabled, log, flush) {
        Ok(()) => ErrorCode::Success,
        Err(err) => err.into(),
    };

    trace!("ursa_set_logger: <<< res: {:?}", res);

    res
}

/// Set default logger implementation.
///
/// Allows library user use `env_logger` logger as default implementation.
/// More details about `env_logger` and its customization can be found here: https://crates.io/crates/env_logger
///
/// #Params
/// pattern: (optional) pattern that corresponds with the log messages to show.
///
/// NOTE: You should specify either `pattern` parameter or `RUST_LOG` environment variable to init logger.
///
/// #Returns
/// Error code
#[no_mangle]
pub extern "C" fn ursa_set_default_logger(pattern: *const c_char) -> ErrorCode {
    trace!("ursa_set_default_logger >>> pattern: {:?}", pattern);

    check_useful_opt_c_str!(pattern, ErrorCode::CommonInvalidParam1);

    trace!(
        "ursa_set_default_logger: entities >>> pattern: {:?}",
        pattern
    );

    let res = match HLCryptoDefaultLogger::init(pattern) {
        Ok(()) => ErrorCode::Success,
        Err(err) => err.into(),
    };

    trace!("ursa_set_default_logger: <<< res: {:?}", res);

    res
}