xref: /freebsd/crypto/krb5/src/plugins/preauth/spake/trace.h (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2 /* plugins/preauth/spake/internal.h - SPAKE internal function declarations */
3 /*
4  * Copyright (C) 2015 by the Massachusetts Institute of Technology.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  *
14  * * Redistributions in binary form must reproduce the above copyright
15  *   notice, this list of conditions and the following disclaimer in
16  *   the documentation and/or other materials provided with the
17  *   distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
24  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
30  * OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef TRACE_H
34 #define TRACE_H
35 
36 #include "k5-int.h"
37 
38 /*
39  * Possible improvements at the cost of more code:
40  * - Groups could be displayed by name instead of number
41  * - We could display the group list when tracing support messages
42  */
43 
44 #define TRACE_SPAKE_CLIENT_THASH(c, thash)                      \
45     TRACE(c, "SPAKE final transcript hash: {hexdata}", thash)
46 #define TRACE_SPAKE_DERIVE_KEY(c, n, kb)                        \
47     TRACE(c, "SPAKE derived K'[{int}] = {keyblock}", n, kb)
48 #define TRACE_SPAKE_KDC_THASH(c, thash)                         \
49     TRACE(c, "SPAKE final transcript hash: {hexdata}", thash)
50 #define TRACE_SPAKE_KEYGEN(c, pubkey)                                   \
51     TRACE(c, "SPAKE key generated with pubkey {hexdata}", pubkey)
52 #define TRACE_SPAKE_RECEIVE_CHALLENGE(c, group, pubkey)                 \
53     TRACE(c, "SPAKE challenge received with group {int}, pubkey {hexdata}", \
54           group, pubkey)
55 #define TRACE_SPAKE_RECEIVE_RESPONSE(c, pubkey)                         \
56     TRACE(c, "SPAKE response received with pubkey {hexdata}", pubkey)
57 #define TRACE_SPAKE_RECEIVE_SUPPORT(c, group)                           \
58     TRACE(c, "SPAKE support message received, selected group {int}", group)
59 #define TRACE_SPAKE_REJECT_CHALLENGE(c, group)                          \
60     TRACE(c, "SPAKE challenge with group {int} rejected", (int)group)
61 #define TRACE_SPAKE_REJECT_SUPPORT(c)           \
62     TRACE(c, "SPAKE support message rejected")
63 #define TRACE_SPAKE_RESULT(c, result)                           \
64     TRACE(c, "SPAKE algorithm result: {hexdata}", result)
65 #define TRACE_SPAKE_SEND_CHALLENGE(c, group)                    \
66     TRACE(c, "Sending SPAKE challenge with group {int}", group)
67 #define TRACE_SPAKE_SEND_RESPONSE(c)            \
68     TRACE(c, "Sending SPAKE response")
69 #define TRACE_SPAKE_SEND_SUPPORT(c)             \
70     TRACE(c, "Sending SPAKE support message")
71 #define TRACE_SPAKE_UNKNOWN_GROUP(c, name)                      \
72     TRACE(c, "Unrecognized SPAKE group name: {str}", name)
73 
74 #endif /* TRACE_H */
75