      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
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381

    use ffi;
    use foreign_types::{ForeignType, ForeignTypeRef, Opaque};
    use libc::c_int;
    use std::borrow::Borrow;
    use std::convert::AsRef;
    use std::fmt;
    use std::iter;
    use std::marker::PhantomData;
    use std::mem;
    use std::ops::{Deref, DerefMut, Index, IndexMut, Range};

    use error::ErrorStack;
    use util::ForeignTypeExt;
    use {cvt, cvt_p};

    cfg_if! {
        if #[cfg(ossl110)] {
            use ffi::{
                OPENSSL_sk_pop, OPENSSL_sk_free, OPENSSL_sk_num, OPENSSL_sk_value, OPENSSL_STACK,
                OPENSSL_sk_new_null, OPENSSL_sk_push,
            };
        } else {
            use ffi::{
                sk_pop as OPENSSL_sk_pop, sk_free as OPENSSL_sk_free, sk_num as OPENSSL_sk_num,
                sk_value as OPENSSL_sk_value, _STACK as OPENSSL_STACK,
                sk_new_null as OPENSSL_sk_new_null, sk_push as OPENSSL_sk_push,
            };
        }
    }

    /// Trait implemented by types which can be placed in a stack.
    ///
    /// It should not be implemented for any type outside of this crate.
    pub trait Stackable: ForeignType {
        /// The C stack type for this element.
        ///
        /// Generally called `stack_st_{ELEMENT_TYPE}`, normally hidden by the
        /// `STACK_OF(ELEMENT_TYPE)` macro in the OpenSSL API.
        type StackType;
    }

    /// An owned stack of `T`.
    pub struct Stack<T: Stackable>(*mut T::StackType);

    unsafe impl<T: Stackable + Send> Send for Stack<T> {}
    unsafe impl<T: Stackable + Sync> Sync for Stack<T> {}

    impl<T> fmt::Debug for Stack<T>
    where
        T: Stackable,
        T::Ref: fmt::Debug,
    {
        fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
            fmt.debug_list().entries(self).finish()
        }
    }
    impl<T: Stackable> Drop for Stack<T> {
        fn drop(&mut self) {
            unsafe {
                while self.pop().is_some() {}
                OPENSSL_sk_free(self.0 as *mut _);
            }
        }
    }

    impl<T: Stackable> Stack<T> {
        pub fn new() -> Result<Stack<T>, ErrorStack> {
            unsafe {
                ffi::init();
                let ptr = cvt_p(OPENSSL_sk_new_null())?;
                Ok(Stack(ptr as *mut _))
            }
        }
    }

    impl<T: Stackable> iter::IntoIterator for Stack<T> {
        type IntoIter = IntoIter<T>;
        type Item = T;

        fn into_iter(self) -> IntoIter<T> {
            let it = IntoIter {
                stack: self.0,
                idxs: 0..self.len() as c_int,
            };
            mem::forget(self);
            it
        }
    }

    impl<T: Stackable> AsRef<StackRef<T>> for Stack<T> {
        fn as_ref(&self) -> &StackRef<T> {
            &*self
        }
    }

    impl<T: Stackable> Borrow<StackRef<T>> for Stack<T> {
        fn borrow(&self) -> &StackRef<T> {
            &*self
        }
    }

    impl<T: Stackable> ForeignType for Stack<T> {
        type CType = T::StackType;
        type Ref = StackRef<T>;

        #[inline]
        unsafe fn from_ptr(ptr: *mut T::StackType) -> Stack<T> {
            assert!(
                !ptr.is_null(),
                "Must not instantiate a Stack from a null-ptr - use Stack::new() in \
                 that case"
            );
            Stack(ptr)
        }

        #[inline]
        fn as_ptr(&self) -> *mut T::StackType {
            self.0
        }
    }

    impl<T: Stackable> Deref for Stack<T> {
        type Target = StackRef<T>;

        fn deref(&self) -> &StackRef<T> {
            unsafe { StackRef::from_ptr(self.0) }
        }
    }

    impl<T: Stackable> DerefMut for Stack<T> {
        fn deref_mut(&mut self) -> &mut StackRef<T> {
            unsafe { StackRef::from_ptr_mut(self.0) }
        }
    }

    pub struct IntoIter<T: Stackable> {
        stack: *mut T::StackType,
        idxs: Range<c_int>,
    }

    impl<T: Stackable> Drop for IntoIter<T> {
        fn drop(&mut self) {
            unsafe {
                while let Some(_) = self.next() {}
                OPENSSL_sk_free(self.stack as *mut _);
            }
        }
    }

    impl<T: Stackable> Iterator for IntoIter<T> {
        type Item = T;

        fn next(&mut self) -> Option<T> {
            unsafe {
                self.idxs
                    .next()
                    .map(|i| T::from_ptr(OPENSSL_sk_value(self.stack as *mut _, i) as *mut _))
            }
        }

        fn size_hint(&self) -> (usize, Option<usize>) {
            self.idxs.size_hint()
        }
    }

    impl<T: Stackable> DoubleEndedIterator for IntoIter<T> {
        fn next_back(&mut self) -> Option<T> {
            unsafe {
                self.idxs
                    .next_back()
                    .map(|i| T::from_ptr(OPENSSL_sk_value(self.stack as *mut _, i) as *mut _))
            }
        }
    }

    impl<T: Stackable> ExactSizeIterator for IntoIter<T> {}

    pub struct StackRef<T: Stackable>(Opaque, PhantomData<T>);

    unsafe impl<T: Stackable + Send> Send for StackRef<T> {}
    unsafe impl<T: Stackable + Sync> Sync for StackRef<T> {}

    impl<T: Stackable> ForeignTypeRef for StackRef<T> {
        type CType = T::StackType;
    }

    impl<T: Stackable> StackRef<T> {
        fn as_stack(&self) -> *mut OPENSSL_STACK {
            self.as_ptr() as *mut _
        }

        /// Returns the number of items in the stack.
        pub fn len(&self) -> usize {
            unsafe { OPENSSL_sk_num(self.as_stack()) as usize }
        }

        /// Determines if the stack is empty.
        pub fn is_empty(&self) -> bool {
            self.len() == 0
        }

        pub fn iter(&self) -> Iter<T> {
            Iter {
                stack: self,
                idxs: 0..self.len() as c_int,
            }
        }

        pub fn iter_mut(&mut self) -> IterMut<T> {
            IterMut {
                idxs: 0..self.len() as c_int,
                stack: self,
            }
        }

        /// Returns a reference to the element at the given index in the
        /// stack or `None` if the index is out of bounds
        pub fn get(&self, idx: usize) -> Option<&T::Ref> {
            unsafe {
                if idx >= self.len() {
                    return None;
                }

                Some(T::Ref::from_ptr(self._get(idx)))
            }
        }

        /// Returns a mutable reference to the element at the given index in the
        /// stack or `None` if the index is out of bounds
        pub fn get_mut(&mut self, idx: usize) -> Option<&mut T::Ref> {
            unsafe {
                if idx >= self.len() {
                    return None;
                }

                Some(T::Ref::from_ptr_mut(self._get(idx)))
            }
        }

        /// Pushes a value onto the top of the stack.
        pub fn push(&mut self, data: T) -> Result<(), ErrorStack> {
            unsafe {
                cvt(OPENSSL_sk_push(self.as_stack(), data.as_ptr() as *mut _))?;
                mem::forget(data);
                Ok(())
            }
        }

        /// Removes the last element from the stack and returns it.
        pub fn pop(&mut self) -> Option<T> {
            unsafe {
                let ptr = OPENSSL_sk_pop(self.as_stack());
                T::from_ptr_opt(ptr as *mut _)
            }
        }

        unsafe fn _get(&self, idx: usize) -> *mut T::CType {
            OPENSSL_sk_value(self.as_stack(), idx as c_int) as *mut _
        }
    }

    impl<T: Stackable> Index<usize> for StackRef<T> {
        type Output = T::Ref;

        fn index(&self, index: usize) -> &T::Ref {
            self.get(index).unwrap()
        }
    }

    impl<T: Stackable> IndexMut<usize> for StackRef<T> {
        fn index_mut(&mut self, index: usize) -> &mut T::Ref {
            self.get_mut(index).unwrap()
        }
    }

    impl<'a, T: Stackable> iter::IntoIterator for &'a StackRef<T> {
        type Item = &'a T::Ref;
        type IntoIter = Iter<'a, T>;

        fn into_iter(self) -> Iter<'a, T> {
            self.iter()
        }
    }

    impl<'a, T: Stackable> iter::IntoIterator for &'a mut StackRef<T> {
        type Item = &'a mut T::Ref;
        type IntoIter = IterMut<'a, T>;

        fn into_iter(self) -> IterMut<'a, T> {
            self.iter_mut()
        }
    }

    impl<'a, T: Stackable> iter::IntoIterator for &'a Stack<T> {
        type Item = &'a T::Ref;
        type IntoIter = Iter<'a, T>;

        fn into_iter(self) -> Iter<'a, T> {
            self.iter()
        }
    }

    impl<'a, T: Stackable> iter::IntoIterator for &'a mut Stack<T> {
        type Item = &'a mut T::Ref;
        type IntoIter = IterMut<'a, T>;

        fn into_iter(self) -> IterMut<'a, T> {
            self.iter_mut()
        }
    }

    /// An iterator over the stack's contents.
    pub struct Iter<'a, T: Stackable>
    where
        T: 'a,
    {
        stack: &'a StackRef<T>,
        idxs: Range<c_int>,
    }

    impl<'a, T: Stackable> Iterator for Iter<'a, T> {
        type Item = &'a T::Ref;

        fn next(&mut self) -> Option<&'a T::Ref> {
            unsafe {
                self.idxs
                    .next()
                    .map(|i| T::Ref::from_ptr(OPENSSL_sk_value(self.stack.as_stack(), i) as *mut _))
            }
        }

        fn size_hint(&self) -> (usize, Option<usize>) {
            self.idxs.size_hint()
        }
    }

    impl<'a, T: Stackable> DoubleEndedIterator for Iter<'a, T> {
        fn next_back(&mut self) -> Option<&'a T::Ref> {
            unsafe {
                self.idxs
                    .next_back()
                    .map(|i| T::Ref::from_ptr(OPENSSL_sk_value(self.stack.as_stack(), i) as *mut _))
            }
        }
    }

    impl<'a, T: Stackable> ExactSizeIterator for Iter<'a, T> {}

    /// A mutable iterator over the stack's contents.
    pub struct IterMut<'a, T: Stackable + 'a> {
        stack: &'a mut StackRef<T>,
        idxs: Range<c_int>,
    }

    impl<'a, T: Stackable> Iterator for IterMut<'a, T> {
        type Item = &'a mut T::Ref;

        fn next(&mut self) -> Option<&'a mut T::Ref> {
            unsafe {
                self.idxs
                    .next()
                    .map(|i| T::Ref::from_ptr_mut(OPENSSL_sk_value(self.stack.as_stack(), i) as *mut _))
            }
        }

        fn size_hint(&self) -> (usize, Option<usize>) {
            self.idxs.size_hint()
        }
    }

    impl<'a, T: Stackable> DoubleEndedIterator for IterMut<'a, T> {
        fn next_back(&mut self) -> Option<&'a mut T::Ref> {
            unsafe {
                self.idxs
                    .next_back()
                    .map(|i| T::Ref::from_ptr_mut(OPENSSL_sk_value(self.stack.as_stack(), i) as *mut _))
            }
        }
    }

    impl<'a, T: Stackable> ExactSizeIterator for IterMut<'a, T> {}