PKCS12_init.3ossl 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "PKCS12_INIT 3ossl"
  58. .TH PKCS12_INIT 3ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. PKCS12_init, PKCS12_init_ex \- Create a new empty PKCS#12 structure
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/pkcs12.h>
  69. \&
  70. \& PKCS12 *PKCS12_init(int mode);
  71. \& PKCS12 *PKCS12_init_ex(int mode, OSSL_LIB_CTX *ctx, const char *propq);
  72. .Ve
  73. .SH DESCRIPTION
  74. .IX Header "DESCRIPTION"
  75. \&\fBPKCS12_init()\fR creates an empty PKCS#12 structure. Any PKCS#7 authSafes added
  76. to this structure are enclosed first within a single PKCS#7 contentInfo
  77. of type \fImode\fR. Currently the only supported type is \fBNID_pkcs7_data\fR.
  78. .PP
  79. \&\fBPKCS12_init_ex()\fR creates an empty PKCS#12 structure and assigns the supplied
  80. \&\fIctx\fR and \fIpropq\fR to be used to select algorithm implementations for
  81. operations performed on the \fBPKCS12\fR object.
  82. .SH "RETURN VALUES"
  83. .IX Header "RETURN VALUES"
  84. \&\fBPKCS12_init()\fR and \fBPKCS12_init_ex()\fR return a valid \fBPKCS12\fR structure or NULL
  85. if an error occurred.
  86. .SH "SEE ALSO"
  87. .IX Header "SEE ALSO"
  88. \&\fBd2i_PKCS12\fR\|(3),
  89. \&\fBPKCS12_create\fR\|(3),
  90. \&\fBpassphrase\-encoding\fR\|(7)
  91. .SH HISTORY
  92. .IX Header "HISTORY"
  93. \&\fBPKCS12_init_ex()\fR was added in OpenSSL 3.0.
  94. .SH COPYRIGHT
  95. .IX Header "COPYRIGHT"
  96. Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
  97. .PP
  98. Licensed under the Apache License 2.0 (the "License"). You may not use
  99. this file except in compliance with the License. You can obtain a copy
  100. in the file LICENSE in the source distribution or at
  101. <https://www.openssl.org/source/license.html>.