/* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */ /* plugins/preauth/pkinit/pkinit_trace.h - PKINIT tracing macros */ /* * Copyright (C) 2012 by the Massachusetts Institute of Technology. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef PKINIT_TRACE_H #define PKINIT_TRACE_H #include "k5-trace.h" #define TRACE_PKINIT_CLIENT_EKU_ACCEPT(c) \ TRACE(c, "PKINIT client found acceptable EKU in KDC cert") #define TRACE_PKINIT_CLIENT_EKU_REJECT(c) \ TRACE(c, "PKINIT client found no acceptable EKU in KDC cert") #define TRACE_PKINIT_CLIENT_EKU_SKIP(c) \ TRACE(c, "PKINIT client skipping EKU check due to configuration") #define TRACE_PKINIT_CLIENT_FRESHNESS_TOKEN(c) \ TRACE(c, "PKINIT client received freshness token from KDC") #define TRACE_PKINIT_CLIENT_KDF_ALG(c, kdf, keyblock) \ TRACE(c, "PKINIT client used KDF {hexdata} to compute reply key " \ "{keyblock}", kdf, keyblock) #define TRACE_PKINIT_CLIENT_KDF_OS2K(c, keyblock) \ TRACE(c, "PKINIT client used octetstring2key to compute reply key " \ "{keyblock}", keyblock) #define TRACE_PKINIT_CLIENT_NO_IDENTITY(c) \ TRACE(c, "PKINIT client has no configured identity; giving up") #define TRACE_PKINIT_CLIENT_REP_CHECKSUM_FAIL(c, expected, received) \ TRACE(c, "PKINIT client checksum mismatch: expected {cksum}, " \ "received {cksum}", expected, received) #define TRACE_PKINIT_CLIENT_REP_DH(c) \ TRACE(c, "PKINIT client verified DH reply") #define TRACE_PKINIT_CLIENT_REP_DH_FAIL(c) \ TRACE(c, "PKINIT client could not verify DH reply") #define TRACE_PKINIT_CLIENT_REP_RSA(c) \ TRACE(c, "PKINIT client verified RSA reply") #define TRACE_PKINIT_CLIENT_REP_RSA_KEY(c, keyblock, cksum) \ TRACE(c, "PKINIT client retrieved reply key {keyblock} from RSA " \ "reply (checksum {cksum})", keyblock, cksum) #define TRACE_PKINIT_CLIENT_REP_RSA_FAIL(c) \ TRACE(c, "PKINIT client could not verify RSA reply") #define TRACE_PKINIT_CLIENT_REQ_CHECKSUM(c, cksum) \ TRACE(c, "PKINIT client computed kdc-req-body checksum {cksum}", cksum) #define TRACE_PKINIT_CLIENT_REQ_DH(c) \ TRACE(c, "PKINIT client making DH request") #define TRACE_PKINIT_CLIENT_REQ_RSA(c) \ TRACE(c, "PKINIT client making RSA request") #define TRACE_PKINIT_CLIENT_SAN_CONFIG_DNSNAME(c, host) \ TRACE(c, "PKINIT client config accepts KDC dNSName SAN {str}", host) #define TRACE_PKINIT_CLIENT_SAN_MATCH_DNSNAME(c, host) \ TRACE(c, "PKINIT client matched KDC hostname {str} against " \ "dNSName SAN; EKU check still required", host) #define TRACE_PKINIT_CLIENT_SAN_MATCH_NONE(c) \ TRACE(c, "PKINIT client found no acceptable SAN in KDC cert") #define TRACE_PKINIT_CLIENT_SAN_MATCH_PRINC(c, princ) \ TRACE(c, "PKINIT client matched KDC principal {princ} against " \ "id-pkinit-san; no EKU check required", princ) #define TRACE_PKINIT_CLIENT_SAN_ERR(c) \ TRACE(c, "PKINIT client failed to decode SANs in KDC cert") #define TRACE_PKINIT_CLIENT_SAN_KDCCERT_DNSNAME(c, host) \ TRACE(c, "PKINIT client found dNSName SAN in KDC cert: {str}", host) #define TRACE_PKINIT_CLIENT_SAN_KDCCERT_PRINC(c, princ) \ TRACE(c, "PKINIT client found id-pkinit-san in KDC cert: {princ}", princ) #define TRACE_PKINIT_CLIENT_TRYAGAIN(c) \ TRACE(c, "PKINIT client trying again with KDC-provided parameters") #define TRACE_PKINIT_OPENSSL_ERROR(c, msg) \ TRACE(c, "PKINIT OpenSSL error: {str}", msg) #define TRACE_PKINIT_PKCS11_GETFLIST_FAILED(c, errstr) \ TRACE(c, "PKINIT PKCS11 C_GetFunctionList failed: {str}", errstr) #define TRACE_PKINIT_PKCS11_GETSYM_FAILED(c, errstr) \ TRACE(c, "PKINIT unable to find PKCS11 plugin symbol " \ "C_GetFunctionList: {str}", errstr) #define TRACE_PKINIT_PKCS11_LOGIN_FAILED(c, errstr) \ TRACE(c, "PKINIT PKCS11 C_Login failed: {str}", errstr) #define TRACE_PKINIT_PKCS11_NO_MATCH_TOKEN(c) \ TRACE(c, "PKINIT PKCS#11 module has no matching tokens") #define TRACE_PKINIT_PKCS11_NO_TOKEN(c) \ TRACE(c, "PKINIT PKCS#11 module shows no slots with tokens") #define TRACE_PKINIT_PKCS11_OPEN(c, name) \ TRACE(c, "PKINIT opening PKCS#11 module \"{str}\"", name) #define TRACE_PKINIT_PKCS11_OPEN_FAILED(c, errstr) \ TRACE(c, "PKINIT PKCS#11 module open failed: {str}", errstr) #define TRACE_PKINIT_PKCS11_SLOT(c, slot, len, label) \ TRACE(c, "PKINIT PKCS#11 slotid {int} token {lenstr}", \ slot, len, label) #define TRACE_PKINIT_SERVER_CERT_AUTH(c, modname) \ TRACE(c, "PKINIT server authorizing cert with module {str}", \ modname) #define TRACE_PKINIT_SERVER_EKU_REJECT(c) \ TRACE(c, "PKINIT server found no acceptable EKU in client cert") #define TRACE_PKINIT_SERVER_EKU_SKIP(c) \ TRACE(c, "PKINIT server skipping EKU check due to configuration") #define TRACE_PKINIT_SERVER_INIT_REALM(c, realm) \ TRACE(c, "PKINIT server initializing realm {str}", realm) #define TRACE_PKINIT_SERVER_INIT_FAIL(c, realm, retval) \ TRACE(c, "PKINIT server initialization failed for realm {str}: {kerr}", \ realm, retval) #define TRACE_PKINIT_SERVER_MATCHING_UPN_FOUND(c) \ TRACE(c, "PKINIT server found a matching UPN SAN in client cert") #define TRACE_PKINIT_SERVER_MATCHING_SAN_FOUND(c) \ TRACE(c, "PKINIT server found a matching SAN in client cert") #define TRACE_PKINIT_SERVER_NO_SAN(c) \ TRACE(c, "PKINIT server found no SAN in client cert") #define TRACE_PKINIT_SERVER_PADATA_VERIFY(c) \ TRACE(c, "PKINIT server verifying KRB5_PADATA_PK_AS_REQ") #define TRACE_PKINIT_SERVER_PADATA_VERIFY_FAIL(c) \ TRACE(c, "PKINIT server failed to verify PA data") #define TRACE_PKINIT_SERVER_RETURN_PADATA(c) \ TRACE(c, "PKINIT server returning PA data") #define TRACE_PKINIT_SERVER_SAN_REJECT(c) \ TRACE(c, "PKINIT server found no acceptable SAN in client cert") #define TRACE_PKINIT_SERVER_UPN_PARSE_FAIL(c, upn, ret) \ TRACE(c, "PKINIT server could not parse UPN \"{str}\": {kerr}", \ upn, ret) #define TRACE_PKINIT_CERT_CHAIN_NAME(c, index, name) \ TRACE(c, "PKINIT chain cert #{int}: {str}", index, name) #define TRACE_PKINIT_CERT_NUM_MATCHING(c, total, nummatch) \ TRACE(c, "PKINIT client checked {int} certs, found {int} matches", \ total, nummatch) #define TRACE_PKINIT_CERT_RULE(c, rule) \ TRACE(c, "PKINIT client matching rule '{str}' against certificates", rule) #define TRACE_PKINIT_CERT_RULE_INVALID(c, rule) \ TRACE(c, "PKINIT client ignoring invalid rule '{str}'", rule) #define TRACE_PKINIT_EKU(c) \ TRACE(c, "PKINIT found acceptable EKU and digitalSignature KU") #define TRACE_PKINIT_EKU_NO_KU(c) \ TRACE(c, "PKINIT found acceptable EKU but no digitalSignature KU") #define TRACE_PKINIT_IDENTITY_OPTION(c, name) \ TRACE(c, "PKINIT loading identity {str}", name) #define TRACE_PKINIT_LOADED_CERT(c, name) \ TRACE(c, "PKINIT loaded cert and key for {str}", name) #define TRACE_PKINIT_LOAD_FROM_FILE(c, name) \ TRACE(c, "PKINIT loading CA certs and CRLs from FILE {str}", name) #define TRACE_PKINIT_LOAD_FROM_DIR(c, name) \ TRACE(c, "PKINIT loading CA certs and CRLs from DIR {str}", name) #define TRACE_PKINIT_NO_CA_ANCHOR(c, file) \ TRACE(c, "PKINIT no anchor CA in file {str}", file) #define TRACE_PKINIT_NO_CA_INTERMEDIATE(c, file) \ TRACE(c, "PKINIT no intermediate CA in file {str}", file) #define TRACE_PKINIT_NO_CERT(c) \ TRACE(c, "PKINIT no certificate provided") #define TRACE_PKINIT_NO_CERT_AND_KEY(c, dirname) \ TRACE(c, "PKINIT no cert and key pair found in directory {str}", \ dirname) #define TRACE_PKINIT_NO_CRL(c, file) \ TRACE(c, "PKINIT no CRL in file {str}", file) #define TRACE_PKINIT_NO_DEFAULT_CERT(c, count) \ TRACE(c, "PKINIT error: There are {int} certs, but there must " \ "be exactly one.", count) #define TRACE_PKINIT_NO_MATCHING_CERT(c) \ TRACE(c, "PKINIT no matching certificate found") #define TRACE_PKINIT_NO_PRIVKEY(c) \ TRACE(c, "PKINIT no private key provided") #define TRACE_PKINIT_PKCS_DECODE_FAIL(c, name) \ TRACE(c, "PKINIT failed to decode PKCS12 file {str} contents", name) #define TRACE_PKINIT_PKCS_OPEN_FAIL(c, name, err) \ TRACE(c, "PKINIT failed to open PKCS12 file {str}: err {errno}", \ name, err) #define TRACE_PKINIT_PKCS_PARSE_FAIL_FIRST(c) \ TRACE(c, "PKINIT initial PKCS12_parse with no password failed") #define TRACE_PKINIT_PKCS_PARSE_FAIL_SECOND(c) \ TRACE(c, "PKINIT second PKCS12_parse with password failed") #define TRACE_PKINIT_PKCS_PROMPT_FAIL(c) \ TRACE(c, "PKINIT failed to prompt for PKCS12 password") #define TRACE_PKINIT_REGEXP_MATCH(c, keyword, comp, value, idx) \ TRACE(c, "PKINIT matched {str} rule '{str}' with " \ "value '{str}' in cert #{int}", keyword, comp, value, (idx) + 1) #define TRACE_PKINIT_REGEXP_NOMATCH(c, keyword, comp, value, idx) \ TRACE(c, "PKINIT didn't match {str} rule '{str}' with " \ "value '{str}' in cert #{int}", keyword, comp, value, (idx) + 1) #define TRACE_PKINIT_SAN_CERT_COUNT(c, count, princ, upns, dns, cert) \ TRACE(c, "PKINIT client found {int} SANs ({int} princs, {int} " \ "UPNs, {int} DNS names) in certificate {str}", count, princ, \ upns, dns, cert) #define TRACE_PKINIT_SAN_CERT_NONE(c, cert) \ TRACE(c, "PKINIT client found no SANs in certificate {str}", cert) #define TRACE_CERTAUTH_VTINIT_FAIL(c, ret) \ TRACE(c, "certauth module failed to init vtable: {kerr}", ret) #define TRACE_CERTAUTH_INIT_FAIL(c, name, ret) \ TRACE(c, "certauth module {str} failed to init: {kerr}", name, ret) #endif /* PKINIT_TRACE_H */