1
0
mirror of https://github.com/opencryptoki/opencryptoki.git synced 2026-10-24 05:39:17 +03:00

43 Commits

Author SHA1 Message Date
Ingo Franzki
bff8d4ae5a DOC: Update README.icsf_stdll to reflect the lasted changes
Incorporate the latest changes for the ICSF token and the pkcsicsf tool
into the README.icsf_stdll.

Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2026-10-08 12:38:18 +02:00
Ingo Franzki
22d88c2ea3 PKCSICSF: Allow to specify the SO PIN and RACF password as option
For better scripting capabilities, the SO PIN and the RACF password can
optionally be supplied via options -R and -S. If not specified you are
prompted for them.

Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2026-09-23 13:25:13 +02:00
Ingo Franzki
7f5c86a549 PKCSICSF: Allow to specify the slot number to create with '-a <token>'
If -slot is specified then create the new ICSF token at the given slot number.
Otherwise the next free slot is used.

Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2026-09-23 13:25:13 +02:00
Ingo Franzki
58d45b6ff1 ICSF: Support public session with SASL authentication
Since SASL authentication does not require unlocking the token master key
to obtain an RACF password, public sessions (sessions opened without a
prior User or SO login) are supported for accessing and operating on public
objects when using SASL. In contrast, Simple authentication requires a User
or SO login before token operations can be performed because the RACF
password must be decrypted from disk using the token master key.

Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2026-09-23 13:25:13 +02:00
Ingo Franzki
767376e898 Editorial updates and fixes in the documentation files
Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2026-08-25 14:45:29 +02:00
Ingo Franzki
69bed96e51 Fix markdown in README.md, coding_style.md and opencryptoki-howto.md
And update as needed.

Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2026-04-14 14:28:06 +02:00
Ingo Franzki
4dda122536 MAKEFILE: Add certain files to EXTRA_DIST or doc_DATA
Those files are referenced in the example RPM spec.

Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2025-05-07 11:28:23 +02:00
Ingo Franzki
7e9b1b64c0 DOC: Fix link to Opencryptoki manual
Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2024-11-07 10:38:21 +01:00
Akash Kulhalli
2d9a12be28 doc: Update COPYRIGHTS, README and coding guidelines
A few new files were added that require specific copyright notices to be
displayed (err.c and getopt_long.c). These files are specific to AIX and are
not used on any other platforms.

The readme has been updated as well, mentioning AIX-specific build instructions
and pitfalls where necessary. The CCA library dependencies have been updated
to reflect what the code now demands for AIX. The base version has been updated
from 5.x to 7.1, which effectively only leaves the 4769 card as the supported
card on AIX. The requirements for Linux are unchanged.

The coding guideline document has been updated as well to outline the required
formatting for preprocessor macros.

Signed-off-by: Akash Kulhalli <akash.kulhalli@ibm.com>
2024-04-24 09:48:07 +02:00
Holger Dengler
530f84d00e build: doc: remove generated files
Extend CLEANFILES to remove generated files during clean target.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>
2022-07-21 15:45:29 +02:00
Ingo Franzki
1ea62406a4 policy: Correct config file names in comments: .conf instead of .cfg
Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2022-04-19 17:11:36 +02:00
Ingo Franzki
e6aa900049 DOC: Update documentation
Closes: https://github.com/opencryptoki/opencryptoki/issues/454

Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com>
2022-03-18 13:13:19 +01:00
Juergen Christ
3db637164b DOC: Added small development documentation
What to do when adding a new mechanism or key type to openCryptoki.  This only
captures the part that is needed in the policy code such that the new
mechanism and/or key type is known to the policy.  It does not capture the
code/part that is needed in the tokens to enforce the policy.

Signed-off-by: Juergen Christ <jchrist@linux.ibm.com>
2021-11-08 16:29:24 +01:00
Juergen Christ
6fd188cefb DOC: Add example policy and strength configurations
These files will also be installed automatically via autotools into the
correct doc folder (typically /usr/share/doc/opencryptoki).

Signed-off-by: Juergen Christ <jchrist@linux.ibm.com>
2021-11-08 16:29:24 +01:00
Eduardo Barretto
49fbb7a769 Add pre-commit hook and update documentation
The pre-commit hook will help developers have their code changes checked
for indentation problems.
Documentation mentions how the hook can be set up.

Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2018-08-08 17:27:53 +02:00
刘群
be1e3dc999 Update opencryptoki-howto.md
Fix broken README links

Signed-off-by: Liu Qun (liuqun) <qunliu@zyhx-group.com>
2018-02-09 10:20:00 -02:00
Eduardo Barretto
2eeaefdd2f Bumping up to version-3.8.0
Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2017-10-27 10:16:36 -02:00
Ingo Tuchscherer
0cc62a6645 Multi token instances - description
Added a short description in the ep11 documentation with a
configuration example

Signed-off-by: Ingo Tuchscherer <ingo.tuchscherer@linux.vnet.ibm.com>
2017-10-06 16:44:11 -03:00
Ingo Franzki
e460cc1ab7 Remove unneeded '#include "slotmgr.h"' in sample
The '#include "slotmgr.h"' is not needed in the sample code, as well
as 'Slot_Mgr_Shr_t  *shmp = NULL;'. File slotmgr.h is not installed
into /usr/include/opencryptoki, so compiling this sample would not
be possible outside of the source tree.

Signed-off-by: Ingo Franzki <ifranzki@linux.vnet.ibm.com>
2017-08-14 09:29:53 -03:00
Eduardo Barretto
488ac1c4d4 Include updated version of opencryptoki HOWTO
This file was previously distributed as a PDF and was really outdated. We are
replacing it for an updated text (.md) file.

Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2017-07-17 17:52:37 -03:00
Eduardo Barretto
f3750137e8 Fix documentation style
Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2017-07-17 17:52:03 -03:00
Eduardo Barretto
73ffa1fb56 ICSF: Fix documentation coding style and minor text mistakes
Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2017-07-17 17:41:44 -03:00
Eduardo Barretto
cb5805842e EP11: Remove deprecated logging info and fix format in documentation
Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2017-07-17 17:38:21 -03:00
Eduardo Barretto
32757b7530 CCA: Update documentation and fix coding style
The README.pkcscca_migrate document was outdated as it mentioned pkcsconf64
which is not present anymore and was integrated into pkcsconf.
Fixed some coding style and small spelling mistakes.

Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2017-07-17 17:35:40 -03:00
Eduardo Barretto
e5de1d7ae9 Remove outdated documents
OpenCryptoki-HOWTO.pdf is from 2005, really outdated, and we shouldn't have a
pdf in the package source. Another file will be written to take its place.
README-IBM_CCA_users was needed when pkcsconf didn't support 64 bits, so there
was a pkcsconf64 tool to help on that. But now this pkcsconf64 doesn't exist
anymore and pkcsconf works for 32 and 64bits.

Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2017-07-11 11:12:36 -03:00
Eduardo Barretto
d65d0581cb Fix typo
Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2017-07-11 11:10:35 -03:00
Eduardo Barretto
be0a20ff48 Add CONTRIBUTING and coding style documentation
CONTRIBUTING file documents how to get started on developing for OpenCryptoki.
The conding style is a guideline about how you should write your code.

Signed-off-by: Eduardo Barretto <ebarretto@linux.vnet.ibm.com>
2017-07-05 16:59:23 -03:00
Paulo Vital
1a32b7c3d5 Remove dependence of pk_config_data in ock_tests.sh
Since opencryptoki-3.0 the file pk_config_data was replaced by the
opencryptoki.conf file. The ock_tests.sh script was still depending
on the pk_config_data file to read slots number to execute.

This patch fixes GitHub issue #12

Signed-off-by: Paulo Vital <pvital@linux.vnet.ibm.com>
2017-06-22 16:42:43 -03:00
Paulo Vital
e11a638de3 Fix spelling of documentation and manuals
Signed-off-by: Paulo Vital <pvital@linux.vnet.ibm.com>
2017-03-03 10:30:44 -03:00
Vineetha Pai
5e3d763d5d Documentation on system resources used by opencryptoki
Signed-off-by: Vineetha Pai <vpishar@us.ibm.com>
2016-07-20 14:54:37 -04:00
Fionnuala Gunter
aa7fb5448a CCA keys are wrapped with a master key, when this master key is changed, the
wrapped keys need to be unwrapped with the old mater key and wrapped with the
new master key. This patch extends the pkcscca tool to migrate wrapped keys.

Signed-off-by: Fionnuala Gunter <fin@linux.vnet.ibm.com>
Signed-off-by: Vineetha Pai <vpishar@us.ibm.com>
2015-10-11 18:31:52 -05:00
Joy Latten
13eda6d102 Add documentation (pkcscca manpage and README.cca_stdll) to assist in
migrating cca private token objects from v2 to v3.

Signed-off-by: Joy Latten <jmlatten@linux.vnet.ibm.com>
2014-09-04 10:18:03 -05:00
Ingo Tuchscherer
2d4ab471d4 EP11: corrected some typos in ep11 README
Signed-off-by: Ingo Tuchscherer <ingo.tuchscherer@linux.vnet.ibm.com>
2014-06-17 11:15:32 -05:00
Ingo Tuchscherer
6589fae156 EP11: some README updates about usage and restrictions.
Signed-off-by: Joy Latten <jmlatten@linux.vnet.ibm.com>
2014-02-12 15:56:46 -06:00
Joy Latten
b9ecf36d8a Add README for ep11 token and man page for ep11 migrate tool.
Signed-off-by: Joy Latten <jmlatten@linux.vnet.ibm.com>
2014-01-26 23:19:28 -06:00
Joy Latten
7175433ac2 Update docs to reflect v3 changes.
Signed-off-by: Joy Latten <jmlatten@linux.vnet.ibm.com>
2013-06-17 16:12:31 -05:00
Joy Latten
ccbe5c8ffc Allow tpm stdll to get SRK passwd from OCK_SRK_SECRET and
the policy's secret mode from OCK_SRK_MODE env variables.

Signed-off-by: Joy Latten <jmlatten@users.sourceforge.net>
2012-02-20 16:05:55 -06:00
Kent Yoder
88585c7c71 updates for token data parsing
The following patch adds documentation on openCryptoki's handling of token data and adds it to the rpm specfile.

Signed-off-by: Kent Yoder <key@linux.vnet.ibm.com>

 doc/README.token_data |   99 +++++++++++++++++++++++++++++++++++++++++++++++++
 rpm/opencryptoki.spec |    2 +-
 2 files changed, 100 insertions(+), 1 deletions(-)
2010-09-02 10:17:43 -03:00
Klaus Heinrich Kiwi
ceee7028f8 Move specific documentation to doc/
Documentation files were scattered across different places. Consolidate
them in doc/ to make packaging easier, while avoiding collisions.

Signed-off-by: Klaus Heinrich Kiwi <klausk@linux.vnet.ibm.com>
2010-07-20 13:39:33 -03:00
kyoder
c91d2181a2 moved to proper manpage format and integrated into the build under man/man* 2007-09-28 15:51:08 +00:00
mhalcrow
98ab4a8043 pkcs11_startup man page 2006-03-10 20:24:51 +00:00
mhalcrow
e0e452ce32 First pass at some man page pre-images for openCryptoki. 2006-03-10 20:21:11 +00:00
kyoder
9961353e5b Initial revision 2005-01-18 16:08:12 +00:00