/usr/include/libnitrokey/dissect.h is in libnitrokey-dev 3.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* Copyright (c) 2015-2018 Nitrokey UG
*
* This file is part of libnitrokey.
*
* libnitrokey is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* libnitrokey is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with libnitrokey. If not, see <http://www.gnu.org/licenses/>.
*
* SPDX-License-Identifier: LGPL-3.0
*/
/*
* Protocol packet dissection
*/
#ifndef DISSECT_H
#define DISSECT_H
#include <string>
#include <sstream>
#include <iomanip>
#include "misc.h"
#include "cxx_semantics.h"
#include "command_id.h"
#include "device_proto.h"
namespace nitrokey {
namespace proto {
template <CommandID id, class HIDPacket>
class QueryDissector : semantics::non_constructible {
public:
static std::string dissect(const HIDPacket &pod) {
std::stringstream out;
#ifdef LOG_VOLATILE_DATA
out << "Raw HID packet:" << std::endl;
out << ::nitrokey::misc::hexdump((const uint8_t *)(&pod), sizeof pod);
#endif
out << "Contents:" << std::endl;
out << "Command ID:\t" << commandid_to_string((CommandID)(pod.command_id))
<< std::endl;
out << "CRC:\t"
<< std::hex << std::setw(2) << std::setfill('0')
<< pod.crc << std::endl;
out << "Payload:" << std::endl;
out << pod.payload.dissect();
return out.str();
}
};
template <CommandID id, class HIDPacket>
class ResponseDissector : semantics::non_constructible {
public:
static std::string status_translate_device(int status){
auto enum_status = static_cast<proto::stick10::device_status>(status);
switch (enum_status){
case stick10::device_status::ok: return "OK";
case stick10::device_status::busy: return "BUSY";
case stick10::device_status::error: return "ERROR";
case stick10::device_status::received_report: return "RECEIVED_REPORT";
}
return std::string("UNKNOWN: ") + std::to_string(status);
}
static std::string to_upper(std::string str){
for (auto & c: str) c = toupper(c);
return str;
}
static std::string status_translate_command(int status){
auto enum_status = static_cast<proto::stick10::command_status >(status);
switch (enum_status) {
#define p(X) case X: return to_upper(std::string(#X));
p(stick10::command_status::ok)
p(stick10::command_status::wrong_CRC)
p(stick10::command_status::wrong_slot)
p(stick10::command_status::slot_not_programmed)
p(stick10::command_status::wrong_password)
p(stick10::command_status::not_authorized)
p(stick10::command_status::timestamp_warning)
p(stick10::command_status::no_name_error)
p(stick10::command_status::not_supported)
p(stick10::command_status::unknown_command)
p(stick10::command_status::AES_dec_failed)
#undef p
}
return std::string("UNKNOWN: ") + std::to_string(status);
}
static std::string dissect(const HIDPacket &pod) {
std::stringstream out;
// FIXME use values from firmware (possibly generate separate
// header automatically)
#ifdef LOG_VOLATILE_DATA
out << "Raw HID packet:" << std::endl;
out << ::nitrokey::misc::hexdump((const uint8_t *)(&pod), sizeof pod);
#endif
out << "Device status:\t" << pod.device_status + 0 << " "
<< status_translate_device(pod.device_status) << std::endl;
out << "Command ID:\t" << commandid_to_string((CommandID)(pod.command_id)) << " hex: " << std::hex << (int)pod.command_id
<< std::endl;
out << "Last command CRC:\t"
<< std::hex << std::setw(2) << std::setfill('0')
<< pod.last_command_crc << std::endl;
out << "Last command status:\t" << pod.last_command_status + 0 << " "
<< status_translate_command(pod.last_command_status) << std::endl;
out << "CRC:\t"
<< std::hex << std::setw(2) << std::setfill('0')
<< pod.crc << std::endl;
if((int)pod.command_id == pod.storage_status.command_id){
out << "Storage stick status (where applicable):" << std::endl;
#define d(x) out << " "#x": \t"<< std::hex << std::setw(2) \
<< std::setfill('0')<< static_cast<int>(x) << std::endl;
d(pod.storage_status.command_counter);
d(pod.storage_status.command_id);
d(pod.storage_status.device_status);
d(pod.storage_status.progress_bar_value);
#undef d
}
out << "Payload:" << std::endl;
out << pod.payload.dissect();
return out.str();
}
};
}
}
#endif
|