xtee-utee-macros 0.2.0

Procedural macros for xTEE Trusted Application model.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
// SPDX-License-Identifier: Apache-2.0
// Copyright (C) 2026 KylinSoft Co., Ltd. <https://www.kylinos.cn/>

extern crate proc_macro;

use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use quote::{format_ident, quote};
use syn::{FnArg, Item, ItemFn, ItemMod, parse_macro_input, spanned::Spanned};

#[proc_macro_attribute]
pub fn ta_create(_args: TokenStream, input: TokenStream) -> TokenStream {
    input
}

#[proc_macro_attribute]
pub fn ta_open_session(_args: TokenStream, input: TokenStream) -> TokenStream {
    input
}

#[proc_macro_attribute]
pub fn ta_close_session(_args: TokenStream, input: TokenStream) -> TokenStream {
    input
}

#[proc_macro_attribute]
pub fn ta_destroy(_args: TokenStream, input: TokenStream) -> TokenStream {
    input
}

#[proc_macro_attribute]
pub fn ta_invoke_command(_args: TokenStream, input: TokenStream) -> TokenStream {
    input
}

#[proc_macro_attribute]
pub fn ta_acl_check(_args: TokenStream, input: TokenStream) -> TokenStream {
    input
}

/// 聚合 TA 入口函数并生成 `TrustedApplication`(socket 模型)。用法:`xtee_ta! { #[ta_create] fn create() ... ... }`,无需额外 `mod`。
#[proc_macro]
pub fn xtee_ta(input: TokenStream) -> TokenStream {
    let file = parse_macro_input!(input as syn::File);
    match expand_xtee_ta_items(file.items) {
        Ok(ts) => ts.into(),
        Err(e) => e.to_compile_error().into(),
    }
}

/// 可选:仍支持 `#[xtee_ta] mod foo { ... }`(旧写法)。
#[proc_macro_attribute]
pub fn xtee_ta_module(_args: TokenStream, input: TokenStream) -> TokenStream {
    let mut item_mod = parse_macro_input!(input as ItemMod);
    let ta_struct_ident = format_ident!("Ta");

    let Some((_, items)) = &mut item_mod.content else {
        return syn::Error::new(
            item_mod.span(),
            "#[xtee_ta_module] only supports inline modules",
        )
        .to_compile_error()
        .into();
    };

    match expand_xtee_ta_items_mut(items, ta_struct_ident) {
        Ok(()) => quote!(#item_mod).into(),
        Err(e) => e.to_compile_error().into(),
    }
}

fn expand_xtee_ta_items(items: Vec<Item>) -> Result<TokenStream2, syn::Error> {
    let ta_struct_ident = format_ident!("Ta");
    let mut items = items;
    expand_xtee_ta_items_mut(&mut items, ta_struct_ident)?;
    Ok(quote! { #(#items)* })
}

fn expand_xtee_ta_items_mut(
    items: &mut Vec<Item>,
    ta_struct_ident: syn::Ident,
) -> Result<(), syn::Error> {
    let mut create_fn: Option<ItemFn> = None;
    let mut open_fn: Option<ItemFn> = None;
    let mut close_fn: Option<ItemFn> = None;
    let mut destroy_fn: Option<ItemFn> = None;
    let mut invoke_fn: Option<ItemFn> = None;
    let mut acl_fn: Option<ItemFn> = None;

    for item in items.iter_mut() {
        let Item::Fn(func) = item else {
            return Err(syn::Error::new(
                item.span(),
                "xtee_ta! only supports `fn` items (put `use` at crate root)",
            ));
        };
        let marker = extract_marker_and_strip(func);
        let Some(marker) = marker else {
            return Err(syn::Error::new(
                func.span(),
                "xtee_ta!: each `fn` must carry one of #[ta_create], #[ta_open_session], #[ta_close_session], #[ta_destroy], #[ta_invoke_command], #[ta_acl_check]",
            ));
        };
        match marker.as_str() {
            "ta_create" => {
                if create_fn.replace(func.clone()).is_some() {
                    return Err(syn::Error::new(
                        func.span(),
                        "duplicate #[ta_create] function",
                    ));
                }
            }
            "ta_open_session" => {
                if open_fn.replace(func.clone()).is_some() {
                    return Err(syn::Error::new(
                        func.span(),
                        "duplicate #[ta_open_session] function",
                    ));
                }
            }
            "ta_close_session" => {
                if close_fn.replace(func.clone()).is_some() {
                    return Err(syn::Error::new(
                        func.span(),
                        "duplicate #[ta_close_session] function",
                    ));
                }
            }
            "ta_destroy" => {
                if destroy_fn.replace(func.clone()).is_some() {
                    return Err(syn::Error::new(
                        func.span(),
                        "duplicate #[ta_destroy] function",
                    ));
                }
            }
            "ta_invoke_command" => {
                if invoke_fn.replace(func.clone()).is_some() {
                    return Err(syn::Error::new(
                        func.span(),
                        "duplicate #[ta_invoke_command] function",
                    ));
                }
            }
            "ta_acl_check" => {
                if acl_fn.replace(func.clone()).is_some() {
                    return Err(syn::Error::new(
                        func.span(),
                        "duplicate #[ta_acl_check] function",
                    ));
                }
            }
            _ => {
                return Err(syn::Error::new(
                    func.span(),
                    "unknown #[ta_*] attribute for xtee_ta!",
                ));
            }
        }
    }

    let Some(create_fn) = create_fn else {
        return Err(syn::Error::new(
            proc_macro2::Span::call_site(),
            "missing #[ta_create] function",
        ));
    };
    let Some(open_fn) = open_fn else {
        return Err(syn::Error::new(
            proc_macro2::Span::call_site(),
            "missing #[ta_open_session] function",
        ));
    };
    let Some(close_fn) = close_fn else {
        return Err(syn::Error::new(
            proc_macro2::Span::call_site(),
            "missing #[ta_close_session] function",
        ));
    };
    let Some(destroy_fn) = destroy_fn else {
        return Err(syn::Error::new(
            proc_macro2::Span::call_site(),
            "missing #[ta_destroy] function",
        ));
    };
    let Some(invoke_fn) = invoke_fn else {
        return Err(syn::Error::new(
            proc_macro2::Span::call_site(),
            "missing #[ta_invoke_command] function",
        ));
    };

    let create_ident = create_fn.sig.ident.clone();
    let destroy_ident = destroy_fn.sig.ident.clone();

    let (session_ctx_ty, open_call, close_call, invoke_call) =
        build_context_and_calls(&open_fn, &close_fn, &invoke_fn)?;

    let acl_check_impl = if let Some(acl_fn) = &acl_fn {
        if acl_fn.sig.inputs.len() != 1 {
            return Err(syn::Error::new(
                acl_fn.sig.span(),
                "#[ta_acl_check] expects fn(ca_auth_info: Option<&CaAuthInfo>)",
            ));
        }
        let acl_ident = &acl_fn.sig.ident;
        quote! {
            fn acl_check(
                &self,
                ca_auth_info: Option<&teec_protocol::CaAuthInfo>,
            ) -> xtee_utee::error::Result<()> {
                __XteeIntoTaResult::into_ta_result(#acl_ident(ca_auth_info))
            }
        }
    } else {
        quote! {}
    };

    let impl_block = quote! {
        use teec_protocol::Parameters;

        pub struct #ta_struct_ident;

        trait __XteeIntoTaResult {
            fn into_ta_result(self) -> xtee_utee::error::Result<()>;
        }

        impl __XteeIntoTaResult for () {
            fn into_ta_result(self) -> xtee_utee::error::Result<()> {
                Ok(())
            }
        }

        impl __XteeIntoTaResult for xtee_utee::error::Result<()> {
            fn into_ta_result(self) -> xtee_utee::error::Result<()> {
                self
            }
        }

        impl xtee_utee::ta_manager::TrustedApplication for #ta_struct_ident {
            type SessionContext = #session_ctx_ty;

            fn create(&self) -> xtee_utee::error::Result<()> {
                __XteeIntoTaResult::into_ta_result(#create_ident())
            }

            #acl_check_impl

            fn open_session(
                &self,
                params: &mut Parameters,
            ) -> xtee_utee::error::Result<Self::SessionContext> {
                #open_call
            }

            fn close_session(
                &self,
                ctx: &mut Self::SessionContext,
            ) -> xtee_utee::error::Result<()> {
                __XteeIntoTaResult::into_ta_result(#close_call)
            }

            fn destroy(&self) -> xtee_utee::error::Result<()> {
                __XteeIntoTaResult::into_ta_result(#destroy_ident())
            }

            fn invoke_command(
                &self,
                cmd_id: u32,
                params: &mut Parameters,
                ctx: &mut Self::SessionContext,
            ) -> xtee_utee::error::Result<()> {
                __XteeIntoTaResult::into_ta_result(#invoke_call)
            }
        }
    };

    let parsed: syn::File = syn::parse2(impl_block).map_err(|e| {
        syn::Error::new(
            proc_macro2::Span::call_site(),
            format!("xtee_ta: failed to parse generated items: {e}"),
        )
    })?;
    for item in parsed.items {
        items.push(item);
    }

    Ok(())
}

fn extract_marker_and_strip(func: &mut ItemFn) -> Option<String> {
    let mut marker: Option<String> = None;
    func.attrs.retain(|attr| {
        let Some(last) = attr.path().segments.last() else {
            return true;
        };
        let name = last.ident.to_string();
        let is_marker = matches!(
            name.as_str(),
            "ta_create"
                | "ta_open_session"
                | "ta_close_session"
                | "ta_destroy"
                | "ta_invoke_command"
                | "ta_acl_check"
        );
        if is_marker {
            marker = Some(name);
            false
        } else {
            true
        }
    });
    marker
}

fn build_context_and_calls(
    open_fn: &ItemFn,
    close_fn: &ItemFn,
    invoke_fn: &ItemFn,
) -> Result<(TokenStream2, TokenStream2, TokenStream2, TokenStream2), syn::Error> {
    let open_arg_count = open_fn.sig.inputs.len();
    let close_arg_count = close_fn.sig.inputs.len();
    let invoke_arg_count = invoke_fn.sig.inputs.len();

    if !(open_arg_count == 1 || open_arg_count == 2) {
        return Err(syn::Error::new(
            open_fn.sig.span(),
            "#[ta_open_session] expects fn(&mut Parameters) or fn(&mut Parameters, &mut T)",
        ));
    }

    if !(close_arg_count == 0 || close_arg_count == 1) {
        return Err(syn::Error::new(
            close_fn.sig.span(),
            "#[ta_close_session] expects fn() or fn(&mut T)",
        ));
    }

    if !(invoke_arg_count == 2 || invoke_arg_count == 3) {
        return Err(syn::Error::new(
            invoke_fn.sig.span(),
            "#[ta_invoke_command] expects fn(cmd_id, &mut Parameters) or fn(&mut T, cmd_id, &mut Parameters)",
        ));
    }

    let open_ident = &open_fn.sig.ident;
    let close_ident = &close_fn.sig.ident;
    let invoke_ident = &invoke_fn.sig.ident;

    if open_arg_count == 1 {
        if close_arg_count != 0 || invoke_arg_count != 2 {
            return Err(syn::Error::new(
                open_fn.sig.span(),
                "no-session-context mode requires close_session() and invoke_command(cmd_id, params)",
            ));
        }
        let session_ctx_ty = quote! { () };
        let open_call = quote! {
            __XteeIntoTaResult::into_ta_result(#open_ident(params))?;
            Ok(())
        };
        let close_call = quote! { #close_ident() };
        let invoke_call = quote! { #invoke_ident(cmd_id, params) };
        return Ok((session_ctx_ty, open_call, close_call, invoke_call));
    }

    let ctx_ty = extract_mut_ref_type(
        open_fn
            .sig
            .inputs
            .iter()
            .nth(1)
            .expect("checked arg count above"),
    )?;
    if close_arg_count != 1 || invoke_arg_count != 3 {
        return Err(syn::Error::new(
            open_fn.sig.span(),
            "session-context mode requires close_session(&mut T) and invoke_command(&mut T, cmd_id, params)",
        ));
    }
    let close_ctx_ty = extract_mut_ref_type(
        close_fn
            .sig
            .inputs
            .iter()
            .next()
            .expect("checked arg count above"),
    )?;
    let invoke_ctx_ty = extract_mut_ref_type(
        invoke_fn
            .sig
            .inputs
            .iter()
            .next()
            .expect("checked arg count above"),
    )?;
    if quote!(#ctx_ty).to_string() != quote!(#close_ctx_ty).to_string()
        || quote!(#ctx_ty).to_string() != quote!(#invoke_ctx_ty).to_string()
    {
        return Err(syn::Error::new(
            open_fn.sig.span(),
            "session context type T must be consistent across ta_open_session/ta_close_session/ta_invoke_command",
        ));
    }

    let session_ctx_ty = quote! { #ctx_ty };
    let open_call = quote! {
        let mut ctx: #ctx_ty = Default::default();
        __XteeIntoTaResult::into_ta_result(#open_ident(params, &mut ctx))?;
        Ok(ctx)
    };
    let close_call = quote! { #close_ident(ctx) };
    let invoke_call = quote! { #invoke_ident(ctx, cmd_id, params) };
    Ok((session_ctx_ty, open_call, close_call, invoke_call))
}

fn extract_mut_ref_type(arg: &FnArg) -> Result<&syn::Type, syn::Error> {
    if let FnArg::Typed(pat_ty) = arg {
        if let syn::Type::Reference(type_ref) = pat_ty.ty.as_ref() {
            if type_ref.mutability.is_some() {
                return Ok(type_ref.elem.as_ref());
            }
        }
    }
    Err(syn::Error::new(arg.span(), "argument must be &mut T"))
}