# error.rs - source
Source of the Rust file `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/openssl-0.10.33/src/error.rs`.
Keywords: rust, rustlang, rust-lang

      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

    //! Errors returned by OpenSSL library.
    //!
    //! OpenSSL errors are stored in an `ErrorStack`.  Most methods in the crate
    //! returns a `Result<T, ErrorStack>` type.
    //!
    //! # Examples
    //!
    //! ```
    //! use openssl::error::ErrorStack;
    //! use openssl::bn::BigNum;
    //!
    //! let an_error = BigNum::from_dec_str("Cannot parse letters");
    //! match an_error {
    //!     Ok(_)  => (),
    //!     Err(e) => println!("Parsing Error: {:?}", e),
    //! }
    //! ```
    use libc::{c_char, c_int, c_ulong};
    use std::borrow::Cow;
    use std::error;
    use std::ffi::CStr;
    use std::fmt;
    use std::io;
    use std::ptr;
    use std::str;

    /// Collection of [`Error`]s from OpenSSL.
    ///
    /// [`Error`]: struct.Error.html
    #[derive(Debug, Clone)]
    pub struct ErrorStack(Vec<Error>);

    impl ErrorStack {
        /// Returns the contents of the OpenSSL error stack.
        pub fn get() -> ErrorStack {
            let mut vec = vec![];
            while let Some(err) = Error::get() {
                vec.push(err);
            }
            ErrorStack(vec)
        }

        /// Pushes the errors back onto the OpenSSL error stack.
        pub fn put(&self) {
            for error in self.errors() {
                error.put();
            }
        }
    }

    impl ErrorStack {
        /// Returns the errors in the stack.
        pub fn errors(&self) -> &[Error] {
            &self.0
        }
    }

    impl fmt::Display for ErrorStack {
        fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
            if self.0.is_empty() {
                return fmt.write_str("OpenSSL error");
            }

            let mut first = true;
            for err in &self.0 {
                if !first {
                    fmt.write_str(", ")?;
                }
                write!(fmt, "{}", err)?;
                first = false;
            }
            Ok(())
        }
    }

    impl error::Error for ErrorStack {}

    impl From<ErrorStack> for io::Error {
        fn from(e: ErrorStack) -> io::Error {
            io::Error::new(io::ErrorKind::Other, e)
        }
    }

    impl From<ErrorStack> for fmt::Error {
        fn from(_: ErrorStack) -> fmt::Error {
            fmt::Error
        }
    }

    /// An error reported from OpenSSL.
    #[derive(Clone)]
    pub struct Error {
        code: c_ulong,
        file: *const c_char,
        line: c_int,
        data: Option<Cow<'static, str>>,
    }

    unsafe impl Sync for Error {}
    unsafe impl Send for Error {}

    impl Error {
        /// Returns the first error on the OpenSSL error stack.
        pub fn get() -> Option<Error> {
            unsafe {
                ffi::init();

                let mut file = ptr::null();
                let mut line = 0;
                let mut data = ptr::null();
                let mut flags = 0;
                match ffi::ERR_get_error_line_data(&mut file, &mut line, &mut data, &mut flags) {
                    0 => None,
                    code => {
                        // The memory referenced by data is only valid until that slot is overwritten
                        // in the error stack, so we'll need to copy it off if it's dynamic
                        let data = if flags & ffi::ERR_TXT_STRING != 0 {
                            let bytes = CStr::from_ptr(data as *const _).to_bytes();
                            let data = str::from_utf8(bytes).unwrap();
                            let data = if flags & ffi::ERR_TXT_MALLOCED != 0 {
                                Cow::Owned(data.to_string())
                            } else {
                                Cow::Borrowed(data)
                            };
                            Some(data)
                        } else {
                            None
                        };
                        Some(Error {
                            code,
                            file,
                            line,
                            data,
                        })
                    }
                }
            }
        }

        /// Pushes the error back onto the OpenSSL error stack.
        pub fn put(&self) {
            unsafe {
                ffi::ERR_put_error(
                    ffi::ERR_GET_LIB(self.code),
                    ffi::ERR_GET_FUNC(self.code),
                    ffi::ERR_GET_REASON(self.code),
                    self.file,
                    self.line,
                );
                let data = match self.data {
                    Some(Cow::Borrowed(data)) => Some((data.as_ptr() as *mut c_char, 0)),
                    Some(Cow::Owned(ref data)) => {
                        let ptr = ffi::CRYPTO_malloc(
                            (data.len() + 1) as _,
                            concat!(file!(), "\0").as_ptr() as _,
                            line!() as _,
                        ) as *mut c_char;
                        if ptr.is_null() {
                            None
                        } else {
                            ptr::copy_nonoverlapping(data.as_ptr(), ptr as *mut u8, data.len());
                            *ptr.add(data.len()) = 0;
                            Some((ptr, ffi::ERR_TXT_MALLOCED))
                        }
                    }
                    None => None,
                };
                if let Some((ptr, flags)) = data {
                    ffi::ERR_set_error_data(ptr, flags | ffi::ERR_TXT_STRING);
                }
            }
        }

        /// Returns the raw OpenSSL error code for this error.
        pub fn code(&self) -> c_ulong {
            self.code
        }

        /// Returns the name of the library reporting the error, if available.
        pub fn library(&self) -> Option<&'static str> {
            unsafe {
                let cstr = ffi::ERR_lib_error_string(self.code);
                if cstr.is_null() {
                    return None;
                }
                let bytes = CStr::from_ptr(cstr as *const _).to_bytes();
                Some(str::from_utf8(bytes).unwrap())
            }
        }

        /// Returns the name of the function reporting the error.
        pub fn function(&self) -> Option<&'static str> {
            unsafe {
                let cstr = ffi::ERR_func_error_string(self.code);
                if cstr.is_null() {
                    return None;
                }
                let bytes = CStr::from_ptr(cstr as *const _).to_bytes();
                Some(str::from_utf8(bytes).unwrap())
            }
        }

        /// Returns the reason for the error.
        pub fn reason(&self) -> Option<&'static str> {
            unsafe {
                let cstr = ffi::ERR_reason_error_string(self.code);
                if cstr.is_null() {
                    return None;
                }
                let bytes = CStr::from_ptr(cstr as *const _).to_bytes();
                Some(str::from_utf8(bytes).unwrap())
            }
        }

        /// Returns the name of the source file which encountered the error.
        pub fn file(&self) -> &'static str {
            unsafe {
                assert!(!self.file.is_null());
                let bytes = CStr::from_ptr(self.file as *const _).to_bytes();
                str::from_utf8(bytes).unwrap()
            }
        }

        /// Returns the line in the source file which encountered the error.
        pub fn line(&self) -> u32 {
            self.line as u32
        }

        /// Returns additional data describing the error.
        #[allow(clippy::option_as_ref_deref)]
        pub fn data(&self) -> Option<&str> {
            self.data.as_ref().map(|s| &**s)
        }
    }

    impl fmt::Debug for Error {
        fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
            let mut builder = fmt.debug_struct("Error");
            builder.field("code", &self.code());
            if let Some(library) = self.library() {
                builder.field("library", &library);
            }
            if let Some(function) = self.function() {
                builder.field("function", &function);
            }
            if let Some(reason) = self.reason() {
                builder.field("reason", &reason);
            }
            builder.field("file", &self.file());
            builder.field("line", &self.line());
            if let Some(data) = self.data() {
                builder.field("data", &data);
            }
            builder.finish()
        }
    }

    impl fmt::Display for Error {
        fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
            write!(fmt, "error:{:08X}", self.code())?;
            match self.library() {
                Some(l) => write!(fmt, ":{}", l)?,
                None => write!(fmt, ":lib({})", ffi::ERR_GET_LIB(self.code()))?,
            }
            match self.function() {
                Some(f) => write!(fmt, ":{}", f)?,
                None => write!(fmt, ":func({})", ffi::ERR_GET_FUNC(self.code()))?,
            }
            match self.reason() {
                Some(r) => write!(fmt, ":{}", r)?,
                None => write!(fmt, ":reason({})", ffi::ERR_GET_REASON(self.code()))?,
            }
            write!(
                fmt,
                ":{}:{}:{}",
                self.file(),
                self.line(),
                self.data().unwrap_or("")
            )
        }
    }

    impl error::Error for Error {}