crypto/heimdal/doc/doxyout/hx509/man/man3/hx509_peer.3

   1 .TH "hx509 certificate selecting functions" 3 "11 Jan 2012" "Version 1.5.2" "Heimdalx509library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 hx509 certificate selecting functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "int \fBhx509_peer_info_alloc\fP (hx509_context context, hx509_peer_info *peer)"
  11 .br
  12 .ti -1c
  13 .RI "void \fBhx509_peer_info_free\fP (hx509_peer_info peer)"
  14 .br
  15 .ti -1c
  16 .RI "int \fBhx509_peer_info_set_cert\fP (hx509_peer_info peer, hx509_cert cert)"
  17 .br
  18 .ti -1c
  19 .RI "int \fBhx509_peer_info_add_cms_alg\fP (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val)"
  20 .br
  21 .ti -1c
  22 .RI "int \fBhx509_peer_info_set_cms_algs\fP (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier *val, size_t len)"
  23 .br
  24 .in -1c
  25 .SH "Detailed Description"
  26 .PP
  27
  28 .SH "Function Documentation"
  29 .PP
  30 .SS "int hx509_peer_info_add_cms_alg (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier * val)"
  31 .PP
  32 Add an additional algorithm that the peer supports.
  33 .PP
  34 \fBParameters:\fP
  35 .RS 4
  36 \fIcontext\fP A hx509 context.
  37 .br
  38 \fIpeer\fP the peer to set the new algorithms for
  39 .br
  40 \fIval\fP an AlgorithmsIdentier to add
  41 .RE
  42 .PP
  43 \fBReturns:\fP
  44 .RS 4
  45 An hx509 error code, see \fBhx509_get_error_string()\fP.
  46 .RE
  47 .PP
  48
  49 .SS "int hx509_peer_info_alloc (hx509_context context, hx509_peer_info * peer)"
  50 .PP
  51 Allocate a new peer info structure an init it to default values.
  52 .PP
  53 \fBParameters:\fP
  54 .RS 4
  55 \fIcontext\fP A hx509 context.
  56 .br
  57 \fIpeer\fP return an allocated peer, free with \fBhx509_peer_info_free()\fP.
  58 .RE
  59 .PP
  60 \fBReturns:\fP
  61 .RS 4
  62 An hx509 error code, see \fBhx509_get_error_string()\fP.
  63 .RE
  64 .PP
  65
  66 .SS "void hx509_peer_info_free (hx509_peer_info peer)"
  67 .PP
  68 Free a peer info structure.
  69 .PP
  70 \fBParameters:\fP
  71 .RS 4
  72 \fIpeer\fP peer info to be freed.
  73 .RE
  74 .PP
  75
  76 .SS "int hx509_peer_info_set_cert (hx509_peer_info peer, hx509_cert cert)"
  77 .PP
  78 Set the certificate that remote peer is using.
  79 .PP
  80 \fBParameters:\fP
  81 .RS 4
  82 \fIpeer\fP peer info to update
  83 .br
  84 \fIcert\fP cerificate of the remote peer.
  85 .RE
  86 .PP
  87 \fBReturns:\fP
  88 .RS 4
  89 An hx509 error code, see \fBhx509_get_error_string()\fP.
  90 .RE
  91 .PP
  92
  93 .SS "int hx509_peer_info_set_cms_algs (hx509_context context, hx509_peer_info peer, const AlgorithmIdentifier * val, size_t len)"
  94 .PP
  95 Set the algorithms that the peer supports.
  96 .PP
  97 \fBParameters:\fP
  98 .RS 4
  99 \fIcontext\fP A hx509 context.
 100 .br
 101 \fIpeer\fP the peer to set the new algorithms for
 102 .br
 103 \fIval\fP array of supported AlgorithmsIdentiers
 104 .br
 105 \fIlen\fP length of array val.
 106 .RE
 107 .PP
 108 \fBReturns:\fP
 109 .RS 4
 110 An hx509 error code, see \fBhx509_get_error_string()\fP.
 111 .RE
 112 .PP
 113