min
/
boring2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document conf module

This commit is contained in:
johnthagen 2017-10-03 17:32:49 -04:00
parent 7159215e45
commit 4f8195c472
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
openssl/src/conf.rs
View File

@ -1,3 +1,4 @@
//! Interface for processing OpenSSL configuration files.
use ffi; use ffi;
use cvt_p; use cvt_p;
@ -6,6 +7,12 @@ use error::ErrorStack;
pub struct ConfMethod(*mut ffi::CONF_METHOD); pub struct ConfMethod(*mut ffi::CONF_METHOD);
impl ConfMethod { impl ConfMethod {
/// Retrieve handle to the default OpenSSL configuration file processing function.
///
/// # OpenSSL Implementation Details
///
/// `NCONF` stands for "New Conf", as described in crypto/conf/conf_lib.c. This is
/// a newer API than the "CONF classic" functions.
pub fn default() -> ConfMethod { pub fn default() -> ConfMethod {
unsafe { unsafe {
ffi::init(); ffi::init();
@ -13,10 +20,12 @@ impl ConfMethod {
} }
} }
/// Construct from raw pointer.
pub unsafe fn from_ptr(ptr: *mut ffi::CONF_METHOD) -> ConfMethod { pub unsafe fn from_ptr(ptr: *mut ffi::CONF_METHOD) -> ConfMethod {
ConfMethod(ptr) ConfMethod(ptr)
} }
/// Convert to raw pointer.
pub fn as_ptr(&self) -> *mut ffi::CONF_METHOD { pub fn as_ptr(&self) -> *mut ffi::CONF_METHOD {
self.0 self.0
} }
@ -31,6 +40,15 @@ foreign_type! {
} }
impl Conf { impl Conf {
/// Create a configuration parser.
///
/// # Examples
///
/// ```
/// use openssl::conf::{Conf, ConfMethod};
///
/// let conf = Conf::new(ConfMethod::default());
/// ```
pub fn new(method: ConfMethod) -> Result<Conf, ErrorStack> { pub fn new(method: ConfMethod) -> Result<Conf, ErrorStack> {
unsafe { cvt_p(ffi::NCONF_new(method.as_ptr())).map(Conf) } unsafe { cvt_p(ffi::NCONF_new(method.as_ptr())).map(Conf) }
} }