xref: /aosp_15_r20/hardware/interfaces/identity/aidl/default/libeic/EicSession.h (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)
1*4d7e907cSAndroid Build Coastguard Worker /*
2*4d7e907cSAndroid Build Coastguard Worker  * Copyright 2021, The Android Open Source Project
3*4d7e907cSAndroid Build Coastguard Worker  *
4*4d7e907cSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*4d7e907cSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*4d7e907cSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*4d7e907cSAndroid Build Coastguard Worker  *
8*4d7e907cSAndroid Build Coastguard Worker  *     http://www.apache.org/licenses/LICENSE-2.0
9*4d7e907cSAndroid Build Coastguard Worker  *
10*4d7e907cSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*4d7e907cSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*4d7e907cSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*4d7e907cSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*4d7e907cSAndroid Build Coastguard Worker  * limitations under the License.
15*4d7e907cSAndroid Build Coastguard Worker  */
16*4d7e907cSAndroid Build Coastguard Worker 
17*4d7e907cSAndroid Build Coastguard Worker #if !defined(EIC_INSIDE_LIBEIC_H) && !defined(EIC_COMPILATION)
18*4d7e907cSAndroid Build Coastguard Worker #error "Never include this file directly, include libeic.h instead."
19*4d7e907cSAndroid Build Coastguard Worker #endif
20*4d7e907cSAndroid Build Coastguard Worker 
21*4d7e907cSAndroid Build Coastguard Worker #ifndef ANDROID_HARDWARE_IDENTITY_EIC_SESSION_H
22*4d7e907cSAndroid Build Coastguard Worker #define ANDROID_HARDWARE_IDENTITY_EIC_SESSION_H
23*4d7e907cSAndroid Build Coastguard Worker 
24*4d7e907cSAndroid Build Coastguard Worker #include "EicOps.h"
25*4d7e907cSAndroid Build Coastguard Worker 
26*4d7e907cSAndroid Build Coastguard Worker #ifdef __cplusplus
27*4d7e907cSAndroid Build Coastguard Worker extern "C" {
28*4d7e907cSAndroid Build Coastguard Worker #endif
29*4d7e907cSAndroid Build Coastguard Worker 
30*4d7e907cSAndroid Build Coastguard Worker typedef struct {
31*4d7e907cSAndroid Build Coastguard Worker     // A non-zero number unique for this EicSession instance
32*4d7e907cSAndroid Build Coastguard Worker     uint32_t id;
33*4d7e907cSAndroid Build Coastguard Worker 
34*4d7e907cSAndroid Build Coastguard Worker     // Set to true iff eicSessionGetEphemeralKeyPair() has been called.
35*4d7e907cSAndroid Build Coastguard Worker     bool getEphemeralKeyPairCalled;
36*4d7e907cSAndroid Build Coastguard Worker 
37*4d7e907cSAndroid Build Coastguard Worker     // The challenge generated at construction time by eicSessionInit().
38*4d7e907cSAndroid Build Coastguard Worker     uint64_t authChallenge;
39*4d7e907cSAndroid Build Coastguard Worker 
40*4d7e907cSAndroid Build Coastguard Worker     uint8_t ephemeralPrivateKey[EIC_P256_PRIV_KEY_SIZE];
41*4d7e907cSAndroid Build Coastguard Worker     uint8_t ephemeralPublicKey[EIC_P256_PUB_KEY_SIZE];
42*4d7e907cSAndroid Build Coastguard Worker 
43*4d7e907cSAndroid Build Coastguard Worker     uint8_t readerEphemeralPublicKey[EIC_P256_PUB_KEY_SIZE];
44*4d7e907cSAndroid Build Coastguard Worker 
45*4d7e907cSAndroid Build Coastguard Worker     uint8_t sessionTranscriptSha256[EIC_SHA256_DIGEST_SIZE];
46*4d7e907cSAndroid Build Coastguard Worker 
47*4d7e907cSAndroid Build Coastguard Worker     size_t readerEphemeralPublicKeySize;
48*4d7e907cSAndroid Build Coastguard Worker } EicSession;
49*4d7e907cSAndroid Build Coastguard Worker 
50*4d7e907cSAndroid Build Coastguard Worker bool eicSessionInit(EicSession* ctx);
51*4d7e907cSAndroid Build Coastguard Worker 
52*4d7e907cSAndroid Build Coastguard Worker bool eicSessionShutdown(EicSession* ctx);
53*4d7e907cSAndroid Build Coastguard Worker 
54*4d7e907cSAndroid Build Coastguard Worker bool eicSessionGetId(EicSession* ctx, uint32_t* outId);
55*4d7e907cSAndroid Build Coastguard Worker 
56*4d7e907cSAndroid Build Coastguard Worker bool eicSessionGetAuthChallenge(EicSession* ctx, uint64_t* outAuthChallenge);
57*4d7e907cSAndroid Build Coastguard Worker 
58*4d7e907cSAndroid Build Coastguard Worker bool eicSessionGetEphemeralKeyPair(EicSession* ctx,
59*4d7e907cSAndroid Build Coastguard Worker                                    uint8_t ephemeralPrivateKey[EIC_P256_PRIV_KEY_SIZE]);
60*4d7e907cSAndroid Build Coastguard Worker 
61*4d7e907cSAndroid Build Coastguard Worker bool eicSessionSetReaderEphemeralPublicKey(
62*4d7e907cSAndroid Build Coastguard Worker         EicSession* ctx, const uint8_t readerEphemeralPublicKey[EIC_P256_PUB_KEY_SIZE]);
63*4d7e907cSAndroid Build Coastguard Worker 
64*4d7e907cSAndroid Build Coastguard Worker bool eicSessionSetSessionTranscript(EicSession* ctx, const uint8_t* sessionTranscript,
65*4d7e907cSAndroid Build Coastguard Worker                                     size_t sessionTranscriptSize);
66*4d7e907cSAndroid Build Coastguard Worker 
67*4d7e907cSAndroid Build Coastguard Worker // Looks up an active session with the given id.
68*4d7e907cSAndroid Build Coastguard Worker //
69*4d7e907cSAndroid Build Coastguard Worker // Returns NULL if no active session with the given id is found.
70*4d7e907cSAndroid Build Coastguard Worker //
71*4d7e907cSAndroid Build Coastguard Worker EicSession* eicSessionGetForId(uint32_t sessionId);
72*4d7e907cSAndroid Build Coastguard Worker 
73*4d7e907cSAndroid Build Coastguard Worker #ifdef __cplusplus
74*4d7e907cSAndroid Build Coastguard Worker }
75*4d7e907cSAndroid Build Coastguard Worker #endif
76*4d7e907cSAndroid Build Coastguard Worker 
77*4d7e907cSAndroid Build Coastguard Worker #endif  // ANDROID_HARDWARE_IDENTITY_EIC_PRESENTATION_H
78