diff --git a/.github/workflows/build-check.yml b/.github/workflows/build-check.yml index fb662b9c..b87bd0c9 100644 --- a/.github/workflows/build-check.yml +++ b/.github/workflows/build-check.yml @@ -88,3 +88,7 @@ jobs: run: cd wolfCrypt-JNI && export PATH=$PATH:"/home/runner/work/documentation" && make html - name: wolfcrypt-jni pdf run: cd wolfCrypt-JNI && export PATH=$PATH:"/home/runner/work/documentation" && make pdf + - name: wolfHSM html + run: cd wolfHSM && export PATH=$PATH:"/home/runner/work/documentation" && make html + - name: wolfHSM pdf + run: cd wolfHSM && export PATH=$PATH:"/home/runner/work/documentation" && make pdf diff --git a/wolfHSM/Doxyfile b/wolfHSM/Doxyfile index dae536d2..b94a478e 100644 --- a/wolfHSM/Doxyfile +++ b/wolfHSM/Doxyfile @@ -485,7 +485,7 @@ NUM_PROC_THREADS = 1 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = YES +EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -614,7 +614,7 @@ HIDE_COMPOUND_REFERENCE= NO # the files that are included by a file in the documentation of that file. # The default value is: YES. -SHOW_INCLUDE_FILES = YES +SHOW_INCLUDE_FILES = NO # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader @@ -693,26 +693,26 @@ STRICT_PROTO_MATCHING = NO # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. -GENERATE_TODOLIST = YES +GENERATE_TODOLIST = NO # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. -GENERATE_TESTLIST = YES +GENERATE_TESTLIST = NO # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. -GENERATE_BUGLIST = YES +GENERATE_BUGLIST = NO # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. -GENERATE_DEPRECATEDLIST= YES +GENERATE_DEPRECATEDLIST= NO # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond @@ -1151,7 +1151,7 @@ USE_HTAGS = NO # See also: Section \class. # The default value is: YES. -VERBATIM_HEADERS = YES +VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index @@ -2195,7 +2195,7 @@ EXPAND_ONLY_PREDEF = NO # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -SEARCH_INCLUDES = YES +SEARCH_INCLUDES = NO # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by the @@ -2298,7 +2298,7 @@ EXTERNAL_PAGES = YES # powerful graphs. # The default value is: YES. -CLASS_DIAGRAMS = YES +CLASS_DIAGRAMS = NO # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The @@ -2362,7 +2362,7 @@ DOT_FONTPATH = # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -CLASS_GRAPH = YES +CLASS_GRAPH = NO # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a # graph for each documented class showing the direct and indirect implementation @@ -2371,14 +2371,14 @@ CLASS_GRAPH = YES # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -COLLABORATION_GRAPH = YES +COLLABORATION_GRAPH = NO # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for # groups, showing the direct groups dependencies. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -GROUP_GRAPHS = YES +GROUP_GRAPHS = NO # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling @@ -2438,7 +2438,7 @@ TEMPLATE_RELATIONS = NO # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -INCLUDE_GRAPH = YES +INCLUDE_GRAPH = NO # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are # set to YES then doxygen will generate a graph for each documented file showing @@ -2447,7 +2447,7 @@ INCLUDE_GRAPH = YES # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -INCLUDED_BY_GRAPH = YES +INCLUDED_BY_GRAPH = NO # If the CALL_GRAPH tag is set to YES then doxygen will generate a call # dependency graph for every global function or class method. @@ -2478,7 +2478,7 @@ CALLER_GRAPH = NO # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -GRAPHICAL_HIERARCHY = YES +GRAPHICAL_HIERARCHY = NO # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the # dependencies a directory has on other directories in a graphical way. The @@ -2487,7 +2487,7 @@ GRAPHICAL_HIERARCHY = YES # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -DIRECTORY_GRAPH = YES +DIRECTORY_GRAPH = NO # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. For an explanation of the image formats see the section @@ -2610,7 +2610,7 @@ DOT_MULTI_TARGETS = NO # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -GENERATE_LEGEND = YES +GENERATE_LEGEND = NO # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate # files that are used to generate the various graphs. diff --git a/wolfHSM/Makefile b/wolfHSM/Makefile index 1edff804..7761ec9f 100644 --- a/wolfHSM/Makefile +++ b/wolfHSM/Makefile @@ -49,11 +49,8 @@ html-prep: api $(Q)cp -a api/md/*8h* build/html/ $(Q)perl -i -pe "s/\/group_/group_/g" build/html/group* build/html/*8h* - $(Q)perl -i -pe "s/\/tpm2_/tpm2_/g" build/html/group* build/html/*8h* $(Q)perl -i -pe "s/dox_comments\/header_files\///" build/html/*8h* - $(Q)cp src/appendix01.md build/html/appendix01.md - # Set input format to gfm to fix issues with converted API docs # Regexes: # 1. Indent all headings by one # @@ -81,4 +78,3 @@ pdf-prep: api $(Q)perl -i -pe "s/(?<=md\#typedef\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/pdf/*.md $(Q)perl -i -pe "s/(?<=md\#enum\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/pdf/*.md - $(Q)cp src/appendix01.md build/pdf/appendix01.md diff --git a/wolfHSM/mkdocs.yml b/wolfHSM/mkdocs.yml index 7e197b9c..b050db33 100644 --- a/wolfHSM/mkdocs.yml +++ b/wolfHSM/mkdocs.yml @@ -12,7 +12,9 @@ nav: - "6. Server Library": chapter06.md - "7. Customizing wolfHSM": chapter07.md - "8. Porting wolfHSM": chapter08.md - - "9. API Reference": appendix01.md + - "9. API Reference": + - Client API: wh__client_8h.md + - Server API: wh__server_8h.md theme: name: null custom_dir: ../mkdocs-material/material diff --git a/wolfHSM/src/chapter05.md b/wolfHSM/src/chapter05.md index 100c4b31..dab16951 100644 --- a/wolfHSM/src/chapter05.md +++ b/wolfHSM/src/chapter05.md @@ -285,7 +285,7 @@ wh_Client_KeyErase(clientCtx, keyId); When using wolfCrypt in the client application, compatible crypto operations can be executed on the wolfHSM server by passing `WOLFHSM_DEV_ID` as the `devId` argument. The wolfHSM client must be initialized before using any wolfHSM remote crypto. -If wolfHSM does not yet support that algorithm, the API call will return `CRYPTOCB_UNAVAILABLE`. See [supported wolfCrypt algorithms](todo) for the full list of algorithms wolfHSM supports for remote HSM execution. +If wolfHSM does not yet support that algorithm, the API call will return `CRYPTOCB_UNAVAILABLE`. Here is an example of how a client application would perform an `AES CBC` encryption operation on the wolfHSM server: diff --git a/wolfHSM/src/chapter08.md b/wolfHSM/src/chapter08.md index 978ae12c..095e7b7b 100644 --- a/wolfHSM/src/chapter08.md +++ b/wolfHSM/src/chapter08.md @@ -28,20 +28,20 @@ Official ports of wolfHSM are provided for various supported architectures, with ### Infineon Aurix TC3XX -(Port in progress) The distribution of this port is restricted by the vendor. Please contact support@wolfssl.com for access. -Infineon Aurix TC3xx +**Infineon Aurix TC3xx** + - Up to 6x 300MHz TriCore application cores - 1x 100MHz ARM Cortex M3 HSM core - Crypto offload: TRNG, AES128, ECDSA, ED25519, SHA ### ST SPC58NN -(Port in progress) The distribution of this port is restricted by the vendor. Please contact support@wolfssl.com for access. -ST SPC58NN +** ST SPC58NN** + - 3x 200MHz e200z4256 PowerPC application cores - 1x 100MHz e200z0 PowerPC HSM core with NVM - Crypto offload: TRNG, AES128