aboutsummaryrefslogtreecommitdiff
path: root/openssl/trunk/doc/crypto/SMIME_write_PKCS7.pod
blob: 61945b388728e9ac3516f3557cde4b4ab14751d7 (plain) (blame)
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
=pod

=head1 NAME

SMIME_write_PKCS7 - convert PKCS#7 structure to S/MIME format.

=head1 SYNOPSIS

int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags);

=head1 DESCRIPTION

SMIME_write_PKCS7() adds the appropriate MIME headers to a PKCS#7
structure to produce an S/MIME message.

B<out> is the BIO to write the data to. B<p7> is the appropriate
B<PKCS7> structure. If cleartext signing (B<multipart/signed>) is
being used then the signed data must be supplied in the B<data> 
argument. B<flags> is an optional set of flags.

=head1 NOTES

The following flags can be passed in the B<flags> parameter.

If B<PKCS7_DETACHED> is set then cleartext signing will be used,
this option only makes sense for signedData where B<PKCS7_DETACHED>
is also set when PKCS7_sign() is also called.

If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain>
are added to the content, this only makes sense if B<PKCS7_DETACHED>
is also set.

If the B<PKCS7_PARTSIGN> flag is set the signed data is finalized
and output along with the content. This flag should only be set
if B<PKCS7_DETACHED> is also set and the previous call to PKCS7_sign()
also set these flags.

If cleartext signing is being used and B<PKCS7_PARTSIGN> not set then
the data must be read twice: once to compute the signature in PKCS7_sign()
and once to output the S/MIME message.

=head1 BUGS

SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there
should be an option to disable this.

=head1 RETURN VALUES

SMIME_write_PKCS7() returns 1 for success or 0 for failure.

=head1 SEE ALSO

L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_sign(3)|PKCS7_sign(3)>,
L<PKCS7_verify(3)|PKCS7_verify(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)>
L<PKCS7_decrypt(3)|PKCS7_decrypt(3)>

=head1 HISTORY

SMIME_write_PKCS7() was added to OpenSSL 0.9.5

=cut
import subprocess import sys import fcntl import os import pwd import errno we_are_root = os.getuid() == 0 beastie = sys.platform.startswith("freebsd") or sys.platform.startswith("darwin") def bin(name, chroot = False): return os.path.join("/bin" if chroot and we_are_root else ac_bindir, name) def etc(name, chroot = False): return os.path.join("/etc" if chroot and we_are_root else ac_sysconfdir, name) def rcy(name): return os.path.join(ac_rcynic_dir, name) def run(*cmd, **kwargs): chroot = kwargs.pop("chroot", False) and we_are_root if we_are_root: if chroot and beastie: cmd = (ac_chroot, "-u", ac_rcynic_user, "-g", ac_rcynic_group, ac_rcynic_dir) + cmd elif chroot and not beastie: cmd = (ac_chrootuid, ac_rcynic_dir, ac_rcynic_user) + cmd elif not chroot and beastie: cmd = (ac_su, "-m", ac_rcynic_user, "-c", " ".join(cmd)) elif not chroot and not beastie: cmd = (ac_sudo, "-u", ac_rcynic_user) + cmd else: raise RuntimeError("How the frell did I get here?") try: subprocess.check_call(cmd, **kwargs) except subprocess.CalledProcessError, e: sys.exit(str(e)) try: lock = os.open(os.path.join(ac_rcynic_dir, "data/lock"), os.O_RDONLY | os.O_CREAT | os.O_NONBLOCK, 0666) fcntl.flock(lock, fcntl.LOCK_EX | fcntl.LOCK_NB) if we_are_root: pw = pwd.getpwnam(ac_rcynic_user) os.fchown(lock, pw.pw_uid, pw.pw_gid) except (IOError, OSError), e: if e.errno == errno.EAGAIN: sys.exit(0) # Another instance of this script is already running, exit silently else: sys.exit("Error %r opening lock %r" % (e.strerror, os.path.join(ac_rcynic_dir, "data/lock"))) run(bin("rcynic", chroot = True), "-c", etc("rcynic.conf", chroot = True), chroot = True) if ac_rcynic_html_dir and os.path.exists(os.path.dirname(ac_rcynic_html_dir)): run(bin("rcynic-html"), rcy("data/rcynic.xml"), ac_rcynic_html_dir) run(bin("rtr-origin"), "--cronjob", rcy("data/authenticated"), cwd = rcy("rpki-rtr")) try: import rpki.gui.cacheview.util rpki.gui.cacheview.util.import_rcynic_xml() except ImportError: pass