chore: make yuzu REUSE compliant
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-14 20:06:02 -04:00
|
|
|
// SPDX-FileCopyrightText: 2018 Citra Emulator Project
|
|
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
2019-08-24 09:57:49 -04:00
|
|
|
|
|
|
|
#include <cstddef>
|
|
|
|
#include <cstring>
|
|
|
|
#include "common/logging/log.h"
|
2021-09-20 17:57:55 -04:00
|
|
|
#include "input_common/helpers/udp_protocol.h"
|
2019-08-24 09:57:49 -04:00
|
|
|
|
|
|
|
namespace InputCommon::CemuhookUDP {
|
|
|
|
|
2019-11-03 01:04:28 -05:00
|
|
|
static constexpr std::size_t GetSizeOfResponseType(Type t) {
|
2019-08-24 09:57:49 -04:00
|
|
|
switch (t) {
|
|
|
|
case Type::Version:
|
|
|
|
return sizeof(Response::Version);
|
|
|
|
case Type::PortInfo:
|
|
|
|
return sizeof(Response::PortInfo);
|
|
|
|
case Type::PadData:
|
|
|
|
return sizeof(Response::PadData);
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
namespace Response {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns Type if the packet is valid, else none
|
|
|
|
*
|
|
|
|
* Note: Modifies the buffer to zero out the crc (since thats the easiest way to check without
|
|
|
|
* copying the buffer)
|
|
|
|
*/
|
|
|
|
std::optional<Type> Validate(u8* data, std::size_t size) {
|
|
|
|
if (size < sizeof(Header)) {
|
2019-11-03 02:07:04 -05:00
|
|
|
return std::nullopt;
|
2019-08-24 09:57:49 -04:00
|
|
|
}
|
2019-11-03 01:04:28 -05:00
|
|
|
Header header{};
|
2019-08-24 09:57:49 -04:00
|
|
|
std::memcpy(&header, data, sizeof(Header));
|
|
|
|
if (header.magic != SERVER_MAGIC) {
|
|
|
|
LOG_ERROR(Input, "UDP Packet has an unexpected magic value");
|
2019-11-03 02:07:04 -05:00
|
|
|
return std::nullopt;
|
2019-08-24 09:57:49 -04:00
|
|
|
}
|
|
|
|
if (header.protocol_version != PROTOCOL_VERSION) {
|
|
|
|
LOG_ERROR(Input, "UDP Packet protocol mismatch");
|
2019-11-03 02:07:04 -05:00
|
|
|
return std::nullopt;
|
2019-08-24 09:57:49 -04:00
|
|
|
}
|
|
|
|
if (header.type < Type::Version || header.type > Type::PadData) {
|
|
|
|
LOG_ERROR(Input, "UDP Packet is an unknown type");
|
2019-11-03 02:07:04 -05:00
|
|
|
return std::nullopt;
|
2019-08-24 09:57:49 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// Packet size must equal sizeof(Header) + sizeof(Data)
|
|
|
|
// and also verify that the packet info mentions the correct size. Since the spec includes the
|
|
|
|
// type of the packet as part of the data, we need to include it in size calculations here
|
|
|
|
// ie: payload_length == sizeof(T) + sizeof(Type)
|
|
|
|
const std::size_t data_len = GetSizeOfResponseType(header.type);
|
|
|
|
if (header.payload_length != data_len + sizeof(Type) || size < data_len + sizeof(Header)) {
|
|
|
|
LOG_ERROR(
|
|
|
|
Input,
|
|
|
|
"UDP Packet payload length doesn't match. Received: {} PayloadLength: {} Expected: {}",
|
|
|
|
size, header.payload_length, data_len + sizeof(Type));
|
2019-11-03 02:07:04 -05:00
|
|
|
return std::nullopt;
|
2019-08-24 09:57:49 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
const u32 crc32 = header.crc;
|
|
|
|
boost::crc_32_type result;
|
|
|
|
// zero out the crc in the buffer and then run the crc against it
|
|
|
|
std::memset(&data[offsetof(Header, crc)], 0, sizeof(u32_le));
|
|
|
|
|
|
|
|
result.process_bytes(data, data_len + sizeof(Header));
|
|
|
|
if (crc32 != result.checksum()) {
|
|
|
|
LOG_ERROR(Input, "UDP Packet CRC check failed. Offset: {}", offsetof(Header, crc));
|
2019-11-03 02:07:04 -05:00
|
|
|
return std::nullopt;
|
2019-08-24 09:57:49 -04:00
|
|
|
}
|
|
|
|
return header.type;
|
|
|
|
}
|
|
|
|
} // namespace Response
|
|
|
|
|
|
|
|
} // namespace InputCommon::CemuhookUDP
|