topic Re: HOW TO INTEGRATE AND USE HSE API in S32G

HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Wed, 16 Oct 2024 07:05:09 GMT

I am using bsp 40 and s32g399ardb3 board.
I have enabled hse and sd card boot mode is successful.[A core as a standalone.]

Now i am supposed to use the hse api to perform hashing on A53 core and other cryptographic operations.
I am referring to the HSE_DEMOAPP_S32G3XX_0_2_22_0 provided by NXP.
How should i move further should i create a custom application or how can i integrate this into my yocto package and compile the main.c ?
Could u please provide some assistance.

Re: HOW TO INTEGRATE AND USE HSE API

chenyin_h — Thu, 17 Oct 2024 07:00:47 GMT

Hello, @ashwini2024

Thanks for you post.

From my understanding, you may want to develop your own code from Linux user space, right?

The HSE DEMO APP is the software packages release by NXP to demostrate the functionality of HSE running on M7 core side, sorry that it could not be directly integrated to Yocto RootFS or your own application targetted running under Linux user space.

Chenyin

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Thu, 17 Oct 2024 07:03:42 GMT

Thank you for the reply.
Could i use the apis and the c code present in that folder and integrate with my yocto package ?
Or could you let me know any other alternative which could be used for generating the hash?

Re: HOW TO INTEGRATE AND USE HSE API

chenyin_h — Fri, 18 Oct 2024 02:47:15 GMT

Hello, @ashwini2024

Thanks for your reply.

Maybe part of the functions that from upper level could be only a reference, but the demo app is targeted running on M7 cores, the APIs are different with the application running on Linux, as a result, it could not be directly referenced for Linux level development from my view.

For Linux based development, the reference code NXP provided is the BSP, which included the HSE driver for Linux, in order to develop your own crypto application, I suggest reading on this part of code for your reference.

Furthermore, since you are interested in the hash, the following code could be a good reference.

https://github.com/nxp-auto-linux/pkcs11-hse/blob/release/bsp41.0/examples/pkcs-msg-digest/pkcs-msg-digest.c

Chenyin

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Fri, 18 Oct 2024 12:25:51 GMT

In my yocto bsp 40 i have files like af alg and kernel crypto apis already present in my package. Could you let me know how i could use these files inorder to invoke those apis and compute the hash for the task. The folder structure is as follows and u can look into it https://github.com/nxp-auto-linux/linux/blob/release/bsp41.0-6.6.25-rt/drivers/crypto/hse/hse-ahash.c#L140

Re: HOW TO INTEGRATE AND USE HSE API

chenyin_h — Mon, 21 Oct 2024 07:46:51 GMT

Hello， @ashwini2024

Thanks for you reply.

As far as I know, we did not have such document that directly fulfill your requirement. I apologize.

From my experience, I understanding that you are willing to develop you own code under Linux with HSE's involvement. I have the following two suggestions for your development:

1. If you are willing to develop kernel driver/kernel module, theoretically you may directly use the hash API of HSE driver for your own use.

I hope it will help.

Chenyin

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Mon, 21 Oct 2024 09:10:27 GMT

Could you give me the steps on how can i proceed with the first option?

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Mon, 21 Oct 2024 09:17:52 GMT

https://github.com/nxp-auto-linux/linux/blob/release/bsp41.0-6.6.25-rt/crypto/algif_hash.c
How can i use this .These above files are present in my yocto package and it generated a .so file How do i use it how can i go further ?

Re: HOW TO INTEGRATE AND USE HSE API

chenyin_h — Tue, 22 Oct 2024 02:09:34 GMT

Hello, @ashwini2024

Thanks for your reply.

As stated before, the 1st option may be theoretically implemented, there should be addtional development work based on current BSP, but I feel sorry that there are not example code nor document related that done by NXP, the users have to study and develop it themselves.

For the second option, the current BSP could support it by using openssl applications.

For the file you mentioned, as displayed from the Makefile "obj-$(CONFIG_CRYPTO_USER_API_HASH) += algif_hash.o", it is user-spaces interface for hash algorithms, while enabled, from my view, this application could be run in user space and directly use the hash algorithms to calculate Hash from kernel functions, it is not to directly use the HSE to offload the Hash operation but using the CPU to calculate the Hash via A53 cores.

Chenyin

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Tue, 22 Oct 2024 05:17:52 GMT

Thank you.
Could u please let me know where i can find the hse_interface.h file

Re: HOW TO INTEGRATE AND USE HSE API

chenyin_h — Tue, 22 Oct 2024 06:10:02 GMT

Hi, @ashwini2024

Thanks for your reply.

The file you mentioned could be found from the interface directory of HSE firmware installation path. you may find it once finish installing the HSE FW package which could be downloaded from your account or the following path:

https://www.nxp.com/app-autopackagemgr/automotive-software-package-manager:AUTO-SW-PACKAGE-MANAGER

I hope it will help.

Chenyin

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Tue, 22 Oct 2024 09:39:34 GMT

Thank you for your reply.
I want hse to compute the hash Could you give me a pathway how that could be done?

Re: HOW TO INTEGRATE AND USE HSE API

chenyin_h — Wed, 23 Oct 2024 02:10:42 GMT

Hello, @ashwini2024

Thanks for the reply.

About your new question, from my experience, as I have listed before, two path that may fulfill your requirements:

1. If you are willing to develop kernel driver/kernel module, theoretically you may directly use the hash API of HSE driver for your own use, no document nor example code existed, you may have to learn the HSE kernel driver in details and develop your own kernel code to use the Hash APIs from the following:

https://github.com/nxp-auto-linux/linux/blob/release/bsp41.0-6.6.25-rt/drivers/crypto/hse/hse-ahash.c

2. If you are willing to develop a Linux user space code, you may reference the pkcs11-hse project from the path I shared, combine the chapter 10 of BSP 41.0 UM, your own user application could directly use the common openssl API to finally access the HSE. The advantage of this way is that there are already BSP UM existed, you may learn it and use the openssl application to directly call the existing functions, for them to do the hash by the HSE, but you may have to reference the current openssl application to learn how to integrate it to your own user space application.

I hope the information above could help on your questions.

Chenyin

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Thu, 24 Oct 2024 10:03:50 GMT

#include <stdio.h>
#include <string.h>
#include <sys/socket.h>
#include <linux/if_alg.h>
#include <unistd.h>

int main() {
    int sockfd, hashfd;
    struct sockaddr_alg sa = {
        .salg_family = AF_ALG,
        .salg_type = "hash",
        .salg_name = "sha256"
    };

    sockfd = socket(AF_ALG, SOCK_SEQPACKET, 0);
    bind(sockfd, (struct sockaddr *)&sa, sizeof(sa));
    hashfd = accept(sockfd, NULL, 0);

char *data = "test data";
write(hashfd, data, strlen(data));

char hash[32];
read(hashfd, hash, 32);

close(hashfd);
close(sockfd);

    printf("Hash: ");
    for (int i = 0; i < 32; i++) {
        printf("%02x", hash[i]);
    }
    printf("\n");

return 0;
}

The above is the code i have used to compute hashing. But it uses the computer for computing the hash.I want the cryptographic operation to get offloaded to the hse engine how can i do that How could i modify the code to include that?

Re: HOW TO INTEGRATE AND USE HSE API

chenyin_h — Mon, 28 Oct 2024 02:32:37 GMT

Hi, @ashwini2024

Thanks for you reply.

I could understand that you want to develop user space application to calculate hash the would be offloaded to the HSE.

But since it is a specific request and no example existed, directly supporting to write it is beyond our forum support scope, I do apologize for your inconvenience. Currently:

1. The Hash computing is supported by HSE.

2. There is no examples that could direct fulfill your needs, you may have to develop it yourself.

3. As is shown in Chapter 10 of BSP UM, the PKCS11 and HSE driver are supported, it could be a valuable reference to develop your own user space application, currently, the HSE could be loaded as a openssl engine, the corresponding openssl operations could be done by HSE instead of using the CPU.

Chenyin

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Tue, 05 Nov 2024 06:35:47 GMT

How could i do the 3 point u mentioned could you please elaborate more ?
THank you.

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Tue, 05 Nov 2024 06:37:10 GMT

How do i load the hse as an openssl engine ?

Re: HOW TO INTEGRATE AND USE HSE API

chenyin_h — Wed, 06 Nov 2024 01:53:00 GMT

Hi, @ashwini2024

I noticed that you have created another post for this topic, I will update the status there.

Chenyin

Re: HOW TO INTEGRATE AND USE HSE API

ashwini2024 — Mon, 11 Nov 2024 13:49:50 GMT

q1)The first option, can u tell me how hse driver is integrated and how can i use it ?How do i enable the driver ?
q2)To access the headers in the kernel source it is possible only through a kernel driver module is that correct ?

Re: HOW TO INTEGRATE AND USE HSE API

chenyin_h — Tue, 12 Nov 2024 02:38:19 GMT

Hello, @ashwini2024

Thanks for you reply.

1. The HSE driver is enabled when builing the BSP following:

It is under driver/crypto/hse/, you may read the code for details for how it integrated to the corresponding kernel, there are not detailed document to introduce the source code of it.

2. I understand that you indeed want to implement a user application taking use of HSE directly, accordng to the BSP UM, it is supported.

I suggest reference this part to write your own application.

In order for best tracking the issue, I suggest discussing it in the other thread, sorry for your inconvenience.

Chenyin