File: cryptbuf.yo

package info (click to toggle)
bobcat 6.02.02-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 13,960 kB
  • sloc: cpp: 18,954; fortran: 5,617; makefile: 2,787; sh: 659; perl: 401; ansic: 26
file content (71 lines) | stat: -rw-r--r-- 2,178 bytes parent folder | download
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
includefile(include/header)

COMMENT(replace 'classname' by the name of the new class)

COMMENT(manpage, section, releasedate, archive, short name)
manpage(FBB::CryptBuf)(3bobcat)(_CurYrs_)(libbobcat-dev__CurVers_)
                    (Base class for DecryptBuf and EncryptBuf)

manpagename(FBB::CryptBuf)(std::streambuf derived base class for DecryptBuf
            and EncryptBuf)

manpagesynopsis()
    bf(#include <bobcat/cryptbuf>)nl()
    Linking option: tt(-lbobcat -lcrypto)

manpagedescription()
    This class is deprecated and will be removed from Bobcat in a future
release. It inherits from tt(FBB::EoiBuf). Classes using tt(CryptBuf) may use
tt(EoiBuf) instead. tt(CryptBuf's) member tt(EVP_CIPHER const *md()) can be
implemented as follows:
        verb(
    #include <openssl/evp.h>

    EVP_CIPHER const *md(char const *cipherName)
    {
        return EVP_CIPHER_fetch(0, cipherName, 0);
    }
        )

includefile(include/namespace)

manpagesection(INHERITS FROM)
    tt(EoiBuf) (and thus from: tt(std::streambuf))

manpagesection(PROTECTED CONSTRUCTOR)

    Analogously to tt(std::streambuf) only a protected constructor is
        available.

    itemization(
    itb(CryptBuf(char const *type, size_t bufSize))
       The type is a null-terminated byte string specifying the de/encryption
        method. E.g., tt(aes-128-cbc). For an overview see the
        bf(encryptbuf)(3bobcat) man-page. The tt(bufSize) parameter defines
        the initial size of the internally used buffer (defined by
        tt(EoiBuf)).
    )

    Copy and move constructors (and assignment operators) are not available.

manpagesection(PROTECTED MEMBER FUNCTION)

   All members of tt(std:streambuf) and tt(EoiBuf) are available, as
    bf(FBB::CryptBuf) inherits from these classes.

    itemization(
    itb(EVP_CIPHER const *md() const)
       A pointer to the cipher information is returned.
    )

manpagefiles()
    em(bobcat/cryptbuf) - defines the class interface

manpageseealso()
    bf(bobcat)(7), bf(eoibuf)(3bobcat), bf(eoi)(3bobcat)

manpagebugs()
    This class is deprecated and will be removed from Bobcat in a future
release.

includefile(include/trailer)