├── source
    ├── SeedRand.h
    ├── SeedRand.cpp
    ├── SaveDataFactory.h
    ├── main.cpp
    └── SaveDataFactory.cpp
├── README.md
├── .gitignore
├── Makefile
└── LICENSE


/source/SeedRand.h:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <stdint.h>
 4 | #include <array>
 5 | #include <cstring>
 6 | 
 7 | class SeedRand {
 8 |    private:
 9 |     std::array<uint32_t, 4> mState;
10 | 
11 |    public:
12 |     SeedRand(uint32_t seed);
13 |     SeedRand(std::array<uint32_t, 4> state);
14 | 
15 |     uint32_t getU32();
16 |     uint64_t getU64();
17 |     std::array<uint32_t, 4> getContext();
18 | };
19 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # splatsave
 2 | C++ implementation of Splatoon 2 save decryption/encryption, supports up to save version 8 (update 5.4.0).
 3 | 
 4 | Requires [mbedtls](https://github.com/ARMmbed/mbedtls) and zlib to compile.
 5 | 
 6 | `make` to compile.
 7 | 
 8 | `make switch` to compile a Switch homebrew PoC version. It can be used with default file name or passing in args with nxlink.
 9 | 
10 | ### Thanks
11 | - Lean for bombing me with hints when I reversed ver 4 shuffle.
12 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Prerequisites
 2 | *.d
 3 | 
 4 | # Compiled Object files
 5 | *.slo
 6 | *.lo
 7 | *.o
 8 | *.obj
 9 | 
10 | # Precompiled Headers
11 | *.gch
12 | *.pch
13 | 
14 | # Compiled Dynamic libraries
15 | *.so
16 | *.dylib
17 | *.dll
18 | 
19 | # Fortran module files
20 | *.mod
21 | *.smod
22 | 
23 | # Compiled Static libraries
24 | *.lai
25 | *.la
26 | *.a
27 | *.lib
28 | 
29 | # Executables
30 | splatsave
31 | *.exe
32 | *.out
33 | *.app
34 | 
35 | # Switch
36 | build/
37 | *.elf
38 | *.nacp
39 | *.nro
40 | *.nso
41 | *.pfs0
42 | 
43 | # Test files
44 | *.dat
45 | *.enc
46 | *.dec
47 | *.bak
48 | *.zip
49 | testsave/
50 | 


--------------------------------------------------------------------------------
/source/SeedRand.cpp:
--------------------------------------------------------------------------------
 1 | #include "SeedRand.h"
 2 | 
 3 | SeedRand::SeedRand(uint32_t seed = 0) {
 4 |     for (int i = 0; i < 4; i++) {
 5 |         mState[i] = (uint32_t)(0x6C078965 * (seed ^ (seed >> 30)) + i + 1);
 6 |         seed = mState[i];
 7 |     }
 8 | }
 9 | 
10 | SeedRand::SeedRand(std::array<uint32_t, 4> state) {
11 |     mState = state;
12 | }
13 | 
14 | uint32_t SeedRand::getU32() {
15 |     uint32_t a = mState[0] ^ (mState[0] << 11);
16 |     uint32_t b = mState[3];
17 |     uint32_t c = a ^ (a >> 8) ^ b ^ (b >> 19);
18 |     for (int i = 0; i < 3; i++)
19 |         mState[i] = mState[i + 1];
20 |     mState[3] = c;
21 |     return c;
22 | }
23 | 
24 | uint64_t SeedRand::getU64() {
25 |     uint32_t a = mState[1];
26 |     uint32_t b = mState[0] ^ (mState[0] << 11);
27 |     uint32_t c = mState[3];
28 |     mState[0] = mState[2];
29 |     mState[1] = c;
30 |     uint32_t d = b ^ (b >> 8) ^ c;
31 |     uint32_t e = d ^ (c >> 19);
32 |     uint32_t f = a ^ (a << 11) ^ ((a ^ (a << 11)) >> 8) ^ e ^ (d >> 19);
33 |     mState[2] = e;
34 |     mState[3] = f;
35 |     return f | ((uint64_t)e << 32);
36 | }
37 | 
38 | std::array<uint32_t, 4> SeedRand::getContext() {
39 |     return mState;
40 | }
41 | 


--------------------------------------------------------------------------------
/source/SaveDataFactory.h:
--------------------------------------------------------------------------------
  1 | #pragma once
  2 | 
  3 | #include <mbedtls/aes.h>
  4 | #include <mbedtls/cipher.h>
  5 | #include <mbedtls/cmac.h>
  6 | #include <mbedtls/ctr_drbg.h>
  7 | #include <mbedtls/entropy.h>
  8 | #include <zlib.h>
  9 | 
 10 | #include <array>
 11 | #include <fstream>
 12 | #include <iostream>
 13 | #include <limits>
 14 | #include <memory>
 15 | #include <vector>
 16 | 
 17 | #include "SeedRand.h"
 18 | 
 19 | class SaveDataFactory {
 20 |    public:
 21 |     enum EncodeState { ENCODED, DECODED };
 22 | 
 23 |    private:
 24 |     static const int ENCODED_FILE_SIZE[];
 25 |     static const int BODY_SIZE[];
 26 | 
 27 |     static const uint8_t HEADER_SIZE = 0x10;
 28 |     static const uint8_t FOOTER_SIZE = 0x30;
 29 | 
 30 |     typedef struct {
 31 |         std::array<uint8_t, 0x10> iv;
 32 |         std::array<uint32_t, 4> keySeed;
 33 |         std::array<uint8_t, 0x10> mac;
 34 |     } SaveFooter;
 35 | 
 36 |     std::unique_ptr<uint8_t[]> m_saveData;
 37 |     std::unique_ptr<uint8_t[]> m_saveData_encoded;
 38 |     uint8_t* m_saveBody;
 39 |     uint8_t* m_saveBody_encoded;
 40 |     SaveFooter* m_saveFooter;
 41 |     size_t m_bodySize;
 42 |     size_t m_fileSize_encoded;
 43 | 
 44 |     // save content
 45 |     int m_version;
 46 |     static const int LATEST_SUPPORT_VERS = 8;
 47 | 
 48 |     // save crypto
 49 |     static const uint32_t CRYPT_TAB1[];
 50 |     static const uint32_t CRYPT_TAB3[];
 51 |     static const uint32_t CRYPT_TAB4[];
 52 |     static const uint32_t CRYPT_TAB7[];
 53 |     const uint32_t* m_cryptTab;
 54 | 
 55 |     std::array<uint8_t, 0x10> getKey(SeedRand& RNG);
 56 | 
 57 |     enum CryptMode { DECRYPT = MBEDTLS_AES_DECRYPT, ENCRYPT = MBEDTLS_AES_ENCRYPT };
 58 | 
 59 |     void cryptBlock(uint8_t* dst, uint8_t* src, size_t size, std::array<uint8_t, 0x10> iv, CryptMode mode,
 60 |                     SeedRand& RNG);
 61 |     void encode();
 62 |     void decode();
 63 |     void updateCRC();
 64 |     int randBytes(uint8_t* output, const size_t output_len);
 65 |     uint32_t reverseBitsU32(uint32_t value);
 66 | 
 67 |     // save shuffle
 68 |     typedef struct {
 69 |         size_t block_size;
 70 |         size_t unshuffled_offset;
 71 |         size_t shuffled_offset;
 72 |     } ShuffleBlock;
 73 | 
 74 |     enum ShuffleMode { SHUFFLE, UNSHUFFLE };
 75 |     enum ShuffleBuffer { ENCODED_BUFF, DECODED_BUFF };
 76 | 
 77 |     void shuffleBody(ShuffleMode mode, ShuffleBuffer targetBuff);
 78 |     std::vector<ShuffleBlock> getShuffleBlocks(size_t total_size, uint32_t seed);
 79 | 
 80 |     EncodeState m_initial_encodeState;
 81 | 
 82 |    public:
 83 |     SaveDataFactory(const std::string save_inPath);
 84 |     ~SaveDataFactory();
 85 | 
 86 |     const uint8_t* getSaveDecodedPtr();
 87 |     const uint8_t* getSaveEncodedPtr();
 88 |     size_t getDecodedSaveFileSize();
 89 |     size_t getEncodedSaveFileSize();
 90 | 
 91 |     int getSaveVersion();
 92 |     EncodeState getInitialEncodeState();
 93 | 
 94 |     class SaveSizeUnknown : public std::exception {
 95 |        public:
 96 |         size_t m_size;
 97 |         int m_version;
 98 |         SaveSizeUnknown(const size_t size, const int version) : m_size(size), m_version(version) {}
 99 |     };
100 |     class DecodeFailToVerify : public std::exception {};
101 |     class CouldNotOpenFile : public std::exception {};
102 |     class UnsupportedSaveVersion : public std::exception {
103 |        public:
104 |         int m_version;
105 |         UnsupportedSaveVersion(const int version) : m_version(version) {}
106 |     };
107 | };
108 | 


--------------------------------------------------------------------------------
/source/main.cpp:
--------------------------------------------------------------------------------
  1 | #include <iostream>
  2 | #include "SaveDataFactory.h"
  3 | 
  4 | #ifdef __SWITCH__
  5 | #include <switch.h>
  6 | #endif
  7 | 
  8 | int splatsave(std::string path, std::string command) {
  9 |     try {
 10 |         SaveDataFactory svFactory(path);
 11 | 
 12 |         const uint8_t* save_write = nullptr;
 13 |         size_t save_write_size = 0;
 14 |         std::string save_output_path;
 15 |         bool isDecode = false;
 16 |         if (svFactory.getInitialEncodeState() == SaveDataFactory::ENCODED) {
 17 |             isDecode = true;
 18 |             save_output_path = path + ".dec";
 19 |             save_write = svFactory.getSaveDecodedPtr();
 20 |             save_write_size = svFactory.getDecodedSaveFileSize();
 21 |         } else {
 22 |             save_output_path = path + ".enc";
 23 |             save_write = svFactory.getSaveEncodedPtr();
 24 |             save_write_size = svFactory.getEncodedSaveFileSize();
 25 |         }
 26 | 
 27 | #ifndef __SWITCH__
 28 |         std::ifstream fileExistCheck(save_output_path);
 29 |         if (fileExistCheck.good()) {
 30 |             std::cout << "Overwrite existing " << save_output_path
 31 |                       << "? (y or n) ";
 32 |             std::string userInput;
 33 |             getline(std::cin, userInput);
 34 |             char firstLetter;
 35 |             if (userInput.length() < 1 or
 36 |                 ((firstLetter = userInput.at(0)) != 'y' and
 37 |                  firstLetter != 'Y')) {
 38 |                 std::cout << "Aborted." << std::endl;
 39 |                 return 0;
 40 |             }
 41 |         }
 42 | #endif
 43 | 
 44 |         std::ofstream fileos(save_output_path, std::fstream::binary);
 45 |         if (!fileos) {
 46 |             std::cout << "Could not open " << save_output_path << std::endl;
 47 |             return -5;
 48 |         }
 49 |         fileos.write((char*)save_write, save_write_size);
 50 |         fileos.close();
 51 | 
 52 |         if (isDecode) {
 53 |             std::cout << "Decrypted " << path << " to " << save_output_path
 54 |                       << "!" << std::endl;
 55 |         } else {
 56 |             std::cout << "Encrypted " << path << " to " << save_output_path
 57 |                       << "!" << std::endl;
 58 |         }
 59 |     } catch (SaveDataFactory::SaveSizeUnknown& e) {
 60 |         if (e.m_version == 6) {
 61 |             std::cout << "Save version 6 was never seen before. If your save "
 62 |                          "was previously unmodified, please submit an issue "
 63 |                          "on the project's GitHub page or send me an email at "
 64 |                          "contact@the3096.com! Thank you."
 65 |                       << std::endl;
 66 |         } else {
 67 |             std::cout << "Save size incorrect: 0x" << std::hex << e.m_size
 68 |                   << std::endl;
 69 |         }
 70 |         return -4;
 71 |     } catch (SaveDataFactory::UnsupportedSaveVersion& e) {
 72 |         std::cout << "Save version unsupported: " << e.m_version << std::endl;
 73 |         return -3;
 74 |     } catch (SaveDataFactory::DecodeFailToVerify& e) {
 75 |         std::cout << "Cannot verify save. If you believe this is a mistake, "
 76 |                      "and your save is intact, please submit an issue "
 77 |                      "on the project's GitHub page or send me an email at "
 78 |                      "contact@the3096.com! Thank you."
 79 |                   << std::endl;
 80 |         return -2;
 81 |     } catch (SaveDataFactory::CouldNotOpenFile& e) {
 82 |         std::cout << "Could not open " << path << std::endl;
 83 |         std::cout << "Usage: " << std::endl;
 84 |         std::cout << command
 85 |                   << " {encrypted save file path} {decrypted output path}"
 86 |                   << std::endl;
 87 |         std::cout << command
 88 |                   << " {decrypted save file path} {re-encrypted output path}"
 89 |                   << std::endl;
 90 |         std::cout << "Decrypt or re-encrypt mode is determined by file size."
 91 |                   << std::endl;
 92 |         return -1;
 93 |     }
 94 | 
 95 |     return 0;
 96 | }
 97 | 
 98 | int main(int argc, char const* argv[]) {
 99 | #ifdef __SWITCH__
100 |     consoleInit(NULL);
101 | #endif
102 | 
103 |     const char* DEFAULT_PATH = "save.dat";
104 |     const char** paths = argv;
105 |     int paths_count;
106 |     if (argc < 2) {
107 |         paths = &DEFAULT_PATH;
108 |         paths_count = 1;
109 |     } else {
110 |         paths = &argv[1];
111 |         paths_count = argc - 1;
112 |     }
113 |     int ret;
114 |     for (int i = 0; i < paths_count; i++) {
115 |         ret = splatsave(paths[i], *argv);
116 |         if (ret != 0) {
117 |             break;
118 |         }
119 |     }
120 | 
121 | #ifdef __SWITCH__
122 |     std::cout << "Press + to exit..." << std::endl;
123 |     while (appletMainLoop()) {
124 |         hidScanInput();
125 |         u64 kDown = hidKeysDown(CONTROLLER_P1_AUTO);
126 |         if (kDown & KEY_PLUS) break;
127 |         consoleUpdate(NULL);
128 |     }
129 |     consoleExit(NULL);
130 | #endif
131 | 
132 |     return ret;
133 | }
134 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
  1 | #---------------------------------------------------------------------------------
  2 | .SUFFIXES:
  3 | #---------------------------------------------------------------------------------
  4 | 
  5 | ifeq ($(strip $(DEVKITPRO)),)
  6 | $(error "Please set DEVKITPRO in your environment. export DEVKITPRO=<path to>/devkitpro")
  7 | endif
  8 | 
  9 | TOPDIR ?= $(CURDIR)
 10 | include $(DEVKITPRO)/libnx/switch_rules
 11 | 
 12 | #---------------------------------------------------------------------------------
 13 | # TARGET is the name of the output
 14 | # BUILD is the directory where object files & intermediate files will be placed
 15 | # SOURCES is a list of directories containing source code
 16 | # DATA is a list of directories containing data files
 17 | # INCLUDES is a list of directories containing header files
 18 | # EXEFS_SRC is the optional input directory containing data copied into exefs, if anything this normally should only contain "main.npdm".
 19 | # ROMFS is the directory containing data to be added to RomFS, relative to the Makefile (Optional)
 20 | #
 21 | # NO_ICON: if set to anything, do not use icon.
 22 | # NO_NACP: if set to anything, no .nacp file is generated.
 23 | # APP_TITLE is the name of the app stored in the .nacp file (Optional)
 24 | # APP_AUTHOR is the author of the app stored in the .nacp file (Optional)
 25 | # APP_VERSION is the version of the app stored in the .nacp file (Optional)
 26 | # APP_TITLEID is the titleID of the app stored in the .nacp file (Optional)
 27 | # ICON is the filename of the icon (.jpg), relative to the project folder.
 28 | #   If not set, it attempts to use one of the following (in this order):
 29 | #     - <Project name>.jpg
 30 | #     - icon.jpg
 31 | #     - <libnx folder>/default_icon.jpg
 32 | #---------------------------------------------------------------------------------
 33 | TARGET		:=	splatsave
 34 | BUILD		:=	build
 35 | SOURCES		:=	source
 36 | DATA		:=	data
 37 | INCLUDES	:=	include
 38 | EXEFS_SRC	:=	exefs_src
 39 | #ROMFS	:=	romfs
 40 | 
 41 | #---------------------------------------------------------------------------------
 42 | # options for code generation
 43 | #---------------------------------------------------------------------------------
 44 | ARCH	:=	-march=armv8-a -mtune=cortex-a57 -mtp=soft -fPIE
 45 | 
 46 | CFLAGS	:=	-g -Wall -O2 -ffunction-sections \
 47 | 			$(ARCH) $(DEFINES)
 48 | 
 49 | CFLAGS	+=	$(INCLUDE) -D__SWITCH__
 50 | 
 51 | CXXFLAGS	:= $(CFLAGS) -fno-rtti -std=gnu++11
 52 | 
 53 | ASFLAGS	:=	-g $(ARCH)
 54 | LDFLAGS	=	-specs=$(DEVKITPRO)/libnx/switch.specs -g $(ARCH) -Wl,-Map,$(notdir $*.map)
 55 | 
 56 | LIBS	:=  -lmbedcrypto -lz -lnx
 57 | 
 58 | #---------------------------------------------------------------------------------
 59 | # list of directories containing libraries, this must be the top level containing
 60 | # include and lib
 61 | #---------------------------------------------------------------------------------
 62 | LIBDIRS	:= $(PORTLIBS) $(LIBNX)
 63 | 
 64 | 
 65 | #---------------------------------------------------------------------------------
 66 | # no real need to edit anything past this point unless you need to add additional
 67 | # rules for different file extensions
 68 | #---------------------------------------------------------------------------------
 69 | ifneq ($(BUILD),$(notdir $(CURDIR)))
 70 | #---------------------------------------------------------------------------------
 71 | 
 72 | export OUTPUT	:=	$(CURDIR)/$(TARGET)
 73 | export TOPDIR	:=	$(CURDIR)
 74 | 
 75 | export VPATH	:=	$(foreach dir,$(SOURCES),$(CURDIR)/$(dir)) \
 76 | 			$(foreach dir,$(DATA),$(CURDIR)/$(dir))
 77 | 
 78 | export DEPSDIR	:=	$(CURDIR)/$(BUILD)
 79 | 
 80 | CFILES		:=	$(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.c)))
 81 | CPPFILES	:=	$(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.cpp)))
 82 | SFILES		:=	$(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.s)))
 83 | BINFILES	:=	$(foreach dir,$(DATA),$(notdir $(wildcard $(dir)/*.*)))
 84 | 
 85 | #---------------------------------------------------------------------------------
 86 | # use CXX for linking C++ projects, CC for standard C
 87 | #---------------------------------------------------------------------------------
 88 | ifeq ($(strip $(CPPFILES)),)
 89 | #---------------------------------------------------------------------------------
 90 | 	export LD	:=	$(CC)
 91 | #---------------------------------------------------------------------------------
 92 | else
 93 | #---------------------------------------------------------------------------------
 94 | 	export LD	:=	$(CXX)
 95 | #---------------------------------------------------------------------------------
 96 | endif
 97 | #---------------------------------------------------------------------------------
 98 | 
 99 | export OFILES_BIN	:=	$(addsuffix .o,$(BINFILES))
100 | export OFILES_SRC	:=	$(CPPFILES:.cpp=.o) $(CFILES:.c=.o) $(SFILES:.s=.o)
101 | export OFILES 	:=	$(OFILES_BIN) $(OFILES_SRC)
102 | export HFILES_BIN	:=	$(addsuffix .h,$(subst .,_,$(BINFILES)))
103 | 
104 | export INCLUDE	:=	$(foreach dir,$(INCLUDES),-I$(CURDIR)/$(dir)) \
105 | 			$(foreach dir,$(LIBDIRS),-I$(dir)/include) \
106 | 			-I$(CURDIR)/$(BUILD)
107 | 
108 | export LIBPATHS	:=	$(foreach dir,$(LIBDIRS),-L$(dir)/lib)
109 | 
110 | export BUILD_EXEFS_SRC := $(TOPDIR)/$(EXEFS_SRC)
111 | 
112 | ifeq ($(strip $(ICON)),)
113 | 	icons := $(wildcard *.jpg)
114 | 	ifneq (,$(findstring $(TARGET).jpg,$(icons)))
115 | 		export APP_ICON := $(TOPDIR)/$(TARGET).jpg
116 | 	else
117 | 		ifneq (,$(findstring icon.jpg,$(icons)))
118 | 			export APP_ICON := $(TOPDIR)/icon.jpg
119 | 		endif
120 | 	endif
121 | else
122 | 	export APP_ICON := $(TOPDIR)/$(ICON)
123 | endif
124 | 
125 | ifeq ($(strip $(NO_ICON)),)
126 | 	export NROFLAGS += --icon=$(APP_ICON)
127 | endif
128 | 
129 | ifeq ($(strip $(NO_NACP)),)
130 | 	export NROFLAGS += --nacp=$(CURDIR)/$(TARGET).nacp
131 | endif
132 | 
133 | ifneq ($(APP_TITLEID),)
134 | 	export NACPFLAGS += --titleid=$(APP_TITLEID)
135 | endif
136 | 
137 | ifneq ($(ROMFS),)
138 | 	export NROFLAGS += --romfsdir=$(CURDIR)/$(ROMFS)
139 | endif
140 | 
141 | .PHONY: $(BUILD) clean switch bin win
142 | #---------------------------------------------------------------------------------
143 | bin: $(SOURCES)
144 | 	g++ $(SOURCES)/*.cpp -o splatsave -std=c++11 -lmbedcrypto -lz
145 | #---------------------------------------------------------------------------------
146 | # Windows rule to use with mingw, mingw openssl pre-built binary: https://wiki.openssl.org/index.php/Binaries
147 | win: $(SOURCES)
148 | 	g++ $(SOURCES)/*.cpp -o splatsave.exe -static -std=c++11 -lmbedcrypto -lz -static-libstdc++ -static-libgcc -lpthread
149 | 
150 | #---------------------------------------------------------------------------------
151 | switch: $(BUILD)
152 | 
153 | $(BUILD):
154 | 	@[ -d $@ ] || mkdir -p $@
155 | 	@$(MAKE) --no-print-directory -C $(BUILD) -f $(CURDIR)/Makefile
156 | 
157 | #---------------------------------------------------------------------------------
158 | clean:
159 | 	@echo clean ...
160 | 	@rm -fr $(BUILD) $(TARGET).pfs0 $(TARGET).nso $(TARGET).nro $(TARGET).nacp $(TARGET).elf
161 | 	$(RM) splatsave 
162 | 	$(RM) splatsave.exe
163 | 
164 | 
165 | #---------------------------------------------------------------------------------
166 | else
167 | .PHONY:	switch
168 | 
169 | DEPENDS	:=	$(OFILES:.o=.d)
170 | 
171 | #---------------------------------------------------------------------------------
172 | # main targets
173 | #---------------------------------------------------------------------------------
174 | switch	:	$(OUTPUT).pfs0 $(OUTPUT).nro
175 | 
176 | $(OUTPUT).pfs0	:	$(OUTPUT).nso
177 | 
178 | $(OUTPUT).nso	:	$(OUTPUT).elf
179 | 
180 | ifeq ($(strip $(NO_NACP)),)
181 | $(OUTPUT).nro	:	$(OUTPUT).elf $(OUTPUT).nacp
182 | else
183 | $(OUTPUT).nro	:	$(OUTPUT).elf
184 | endif
185 | 
186 | $(OUTPUT).elf	:	$(OFILES)
187 | 
188 | $(OFILES_SRC)	: $(HFILES_BIN)
189 | 
190 | #---------------------------------------------------------------------------------
191 | # you need a rule like this for each extension you use as binary data
192 | #---------------------------------------------------------------------------------
193 | %.bin.o	%_bin.h :	%.bin
194 | #---------------------------------------------------------------------------------
195 | 	@echo $(notdir $<)
196 | 	@$(bin2o)
197 | 
198 | -include $(DEPENDS)
199 | 
200 | #---------------------------------------------------------------------------------------
201 | endif
202 | #---------------------------------------------------------------------------------------
203 | 


--------------------------------------------------------------------------------
/source/SaveDataFactory.cpp:
--------------------------------------------------------------------------------
  1 | #include "SaveDataFactory.h"
  2 | 
  3 | #ifdef __SWITCH__
  4 | #    include <switch.h>
  5 | #endif
  6 | 
  7 | // clang-format off
  8 | 
  9 | const int SaveDataFactory::ENCODED_FILE_SIZE[] = {
 10 |     0x483B0, 0x483E0, 0x86840, 0x88D90, 0x88D90, 0x88D90, -1, 0x88D90, 0x88D90
 11 | };
 12 | const int SaveDataFactory::BODY_SIZE[] = {
 13 |     0x483A0, 0x483A0, 0x86800, 0x88D50, 0x88D50, 0x88D50, -1, 0x88D50, 0x88D50
 14 | };
 15 | 
 16 | const uint32_t SaveDataFactory::CRYPT_TAB1[] = {
 17 |     0x476BC5E7, 0x76DF4A26, 0x2BD714E2, 0x632623A5,
 18 |     0xD36838ED, 0x7583042F, 0x32B3A6CE, 0x301180A2,
 19 |     0x63479874, 0xB0EEF148, 0x4144F37F, 0x717EDD13,
 20 |     0xA7C02D5F, 0xDF535C64, 0x1816AA04, 0xC3E911A8,
 21 |     0x07E6D14A, 0xFAE665ED, 0xE0A4AA9E, 0xB271F407,
 22 |     0xE57CCA4F, 0xD2CBFF86, 0x33AC5C1A, 0x10867E0A,
 23 |     0x42E43493, 0x8CCBC746, 0x1E82ECBC, 0xFDE23A9C,
 24 |     0x52A93E3D, 0x617A7898, 0x0753255C, 0xDFF1DEC9,
 25 |     0x310E0F37, 0x1C4BA740, 0x8E02AB06, 0xDDBE8580,
 26 |     0xC714785E, 0x0B24EB7B, 0xE6951F2F, 0x728EBF81,
 27 |     0xA10ABBBF, 0x47F5244F, 0xF96AD9DA, 0x8B8472CD,
 28 |     0xEE47B55B, 0xA1E97980, 0xF30B7FDA, 0xFD230EE1,
 29 |     0x7BF84A0E, 0x705A2AFC, 0x6685E6A1, 0x98AAB220,
 30 |     0x2B307047, 0x551804EB, 0x183A95BB, 0x4531F3E8,
 31 |     0xFDCB1756, 0xF0387032, 0x1F27AC7D, 0x5AD014E2,
 32 |     0x6508E3B3, 0xF13D7C92, 0xD7DA45D4, 0xA01D9485
 33 | };
 34 | 
 35 | const uint32_t SaveDataFactory::CRYPT_TAB3[] = {
 36 |     0xDFD0A132, 0x1537D7E5, 0xC8B0F6D5, 0x6C31FED3,
 37 |     0xB7A1221A, 0x9B9DC40C, 0x44315579, 0xF239E05A,
 38 |     0x87E4D9AF, 0x59EF5961, 0xF5AF2DC9, 0xD1521C02,
 39 |     0x68405262, 0x9864C589, 0x98F5F8BE, 0x0C90FE24,
 40 |     0x9B3FC02A, 0x31E4FD02, 0xEC747B2D, 0x5FC1C04E,
 41 |     0x80D6B732, 0x32BA6CB7, 0x961A5683, 0x33025098,
 42 |     0xD5676789, 0xAB622A5A, 0xF651F93A, 0x130D6D68,
 43 |     0xEFFEDA48, 0x24E2C2D3, 0xEA89C5DD, 0xF04AFA58,
 44 |     0x767D3A19, 0xBF67B888, 0x54218F00, 0x6F461AFF,
 45 |     0x9A216E37, 0x5861AAD0, 0x3B44CEAE, 0xCD6C9A42,
 46 |     0x0610ECD2, 0x2A894F76, 0x23D72BE9, 0x63FA2D93,
 47 |     0x2ADC8A10, 0xFB0E9F6A, 0x3BE0CE91, 0x80BB93A1,
 48 |     0xDB8D8FF3, 0x72E21DC7, 0x93B0C670, 0x2907C541,
 49 |     0x3DBF1C6D, 0x62D8924F, 0x3205E36F, 0x041C44D5,
 50 |     0xDACB2490, 0x01D905A9, 0x6C8C579B, 0xE3C54DC2,
 51 |     0xF4583808, 0x76459488, 0x1E5F7C61, 0x2876F360
 52 | };
 53 | 
 54 | const uint32_t SaveDataFactory::CRYPT_TAB4[]  = {
 55 |     0x0B11FBD2, 0x6D17658A, 0x12975EE9, 0xAAAA885D,
 56 |     0x2EE139B1, 0xF80C32D2, 0x50C45B2C, 0xAED2D909,
 57 |     0x89D951D3, 0x10DA7898, 0x62B55C94, 0x5A97DB5A,
 58 |     0x19834E12, 0xDA5EEB02, 0x12C75D21, 0xF66E1928,
 59 |     0xF59E2A29, 0xD8B5C963, 0xF0B3A901, 0x76924966,
 60 |     0x7259EAFF, 0x04D1CB06, 0x6947913C, 0x8D7A3C0B,
 61 |     0x30C93149, 0xBACA45AD, 0xEF51EDB9, 0xB3970E3C,
 62 |     0xCAAD227E, 0x22A2F1AB, 0x42FEEC63, 0x4913ECEE,
 63 |     0xEA0E8960, 0xDF141223, 0x6A3C6056, 0xBC9E8563,
 64 |     0x22455E19, 0x5DBFD578, 0xD4083049, 0x9CF50236,
 65 |     0x94483227, 0x37FF21C3, 0xA2E0D50D, 0x963097D5,
 66 |     0x433C563E, 0x8D0396A3, 0x29EF72B3, 0x3B73C664,
 67 |     0x9A5FEA92, 0x0B78C1F4, 0x595050C2, 0xFCB5FD6A,
 68 |     0x99DB9314, 0x546196BA, 0x8F6C0AB4, 0xDC61E89E,
 69 |     0x99678335, 0xC1EB02E5, 0x2E3D89C6, 0xFDCBB187,
 70 |     0x5810FB20, 0xC17526ED, 0x03C4F4BC, 0xA3233ACA
 71 | };
 72 | 
 73 | const uint32_t SaveDataFactory::CRYPT_TAB7[]  = {
 74 |     0x266715A6, 0x89D12790, 0x6A2FB118, 0x781CE44A,
 75 |     0x66C804CA, 0x66254224, 0x71959889, 0xEE341C45,
 76 |     0xC8FCBB1D, 0x8484F444, 0x5908658D, 0x17908CDD,
 77 |     0x3A99F961, 0x991C0CA2, 0x83223601, 0x1047B4DC,
 78 |     0xE5E01544, 0x9CE06C46, 0x0EE0D3E5, 0x232C67B1,
 79 |     0xC6831CA5, 0x599EDA6F, 0x51E95542, 0x11B8A121,
 80 |     0xCF00F187, 0x60E207AA, 0x7BBA0DB1, 0xAFDF1A4E,
 81 |     0x679B4AFB, 0x1734CEF5, 0xBC489E27, 0xEB12EE8A,
 82 |     0x5663AD81, 0xE79182DE, 0x1FD081AD, 0x63CA5A63,
 83 |     0x288EFC3E, 0x43620C83, 0xD82430AB, 0xE90C708E,
 84 |     0xB63C0E9D, 0xE5690ACD, 0x1C31DFA3, 0x963354AB,
 85 |     0xC02DE816, 0x6DBFADBC, 0xFFE1AB6F, 0xF37B2E34,
 86 |     0x5CB90515, 0xCCFB9173, 0x3EB3E150, 0x1493623C,
 87 |     0x80965C16, 0x90F6357E, 0x31EEFF51, 0xBEE3F9D2,
 88 |     0x8CA774F4, 0xADDBFDDB, 0xEB898B46, 0x4A05D28C,
 89 |     0xFDB20FEC, 0x8FF500A4, 0x288179A7, 0x4C745F89
 90 | };
 91 | 
 92 | // clang-format on
 93 | 
 94 | SaveDataFactory::SaveDataFactory(const std::string save_inPath) {
 95 |     auto saveFileIS = std::ifstream(save_inPath.c_str(), std::ios::binary | std::ios::ate);
 96 |     auto saveFileInSize = saveFileIS.tellg();
 97 |     saveFileIS.seekg(0, std::ios::beg);
 98 | 
 99 |     if (saveFileInSize < 0) {
100 |         saveFileIS.close();
101 |         throw CouldNotOpenFile();
102 |     }
103 | 
104 |     auto p_saveFileInBuffer = std::make_unique<uint8_t[]>(saveFileInSize);
105 |     saveFileIS.read((char*)p_saveFileInBuffer.get(), saveFileInSize);
106 |     saveFileIS.close();
107 | 
108 |     m_version = *(decltype(m_version)*)p_saveFileInBuffer.get();
109 | 
110 |     // check version
111 |     if (m_version > LATEST_SUPPORT_VERS || m_version < 0) {
112 |         throw UnsupportedSaveVersion(m_version);
113 |     }
114 | 
115 |     // check size to set m_initial_encodeState and sizes
116 |     if (saveFileInSize == HEADER_SIZE + BODY_SIZE[m_version]) {
117 |         m_initial_encodeState = DECODED;
118 |     } else if (saveFileInSize == ENCODED_FILE_SIZE[m_version]) {
119 |         m_initial_encodeState = ENCODED;
120 |     } else {
121 |         throw SaveSizeUnknown(saveFileInSize, m_version);
122 |     }
123 | 
124 |     // select crypto look up table and save sizes
125 |     switch (m_version) {
126 |         case 1:
127 |         case 2:
128 |             m_cryptTab = CRYPT_TAB1;
129 |             break;
130 |         case 3:
131 |             m_cryptTab = CRYPT_TAB3;
132 |             break;
133 |         case 4:
134 |         case 5:
135 |             m_cryptTab = CRYPT_TAB4;
136 |             break;
137 |         case 7:
138 |         case 8:
139 |             m_cryptTab = CRYPT_TAB7;
140 |             break;
141 |         case 6:
142 |         default:
143 |             throw UnsupportedSaveVersion(m_version);
144 |     }
145 | 
146 |     m_fileSize_encoded = ENCODED_FILE_SIZE[m_version];
147 |     m_bodySize = BODY_SIZE[m_version];
148 | 
149 |     // initialize save buffers and pointers
150 |     if (m_initial_encodeState == ENCODED) {
151 |         m_saveData = std::make_unique<uint8_t[]>(HEADER_SIZE + BODY_SIZE[m_version]);
152 |         m_saveData_encoded = std::move(p_saveFileInBuffer);
153 |     } else {
154 |         m_saveData = std::move(p_saveFileInBuffer);
155 |         m_saveData_encoded = std::make_unique<uint8_t[]>(ENCODED_FILE_SIZE[m_version]);
156 |     }
157 |     m_saveBody = &m_saveData[HEADER_SIZE];
158 |     m_saveBody_encoded = &m_saveData_encoded[HEADER_SIZE];
159 |     if (m_version != 0) {
160 |         m_saveFooter = (SaveFooter*)&m_saveData_encoded[m_fileSize_encoded - FOOTER_SIZE];
161 |     } else {
162 |         m_saveFooter = nullptr;
163 |     }
164 | 
165 |     try {
166 |         if (m_initial_encodeState == ENCODED) {
167 |             decode();
168 |         }
169 |     } catch (DecodeFailToVerify& e) {
170 |         this->~SaveDataFactory();
171 |         throw e;
172 |     }
173 | 
174 |     // in case crc is not fixed
175 |     updateCRC();
176 | }
177 | 
178 | SaveDataFactory::~SaveDataFactory() {}
179 | 
180 | std::array<uint8_t, 0x10> SaveDataFactory::getKey(SeedRand& RNG) {
181 |     std::array<uint8_t, 0x10> key;
182 |     for (int i = 0; i < 4; i++) {
183 |         uint32_t k = 0;
184 |         for (int j = 0; j < 4; j++) {
185 |             k <<= 8;
186 |             k |= (uint32_t)((m_cryptTab[RNG.getU32() >> 26] >> ((RNG.getU32() >> 27) & 0x18)) & 0xFF);
187 |         }
188 |         ((uint32_t*)&key)[i] = k;
189 |     }
190 | 
191 |     return key;
192 | }
193 | 
194 | void SaveDataFactory::cryptBlock(uint8_t* dst, uint8_t* src, size_t size, std::array<uint8_t, 0x10> iv, CryptMode mode,
195 |                                  SeedRand& RNG) {
196 |     std::array<uint8_t, 0x10> key = getKey(RNG);
197 |     mbedtls_aes_context ctx;
198 |     mbedtls_aes_init(&ctx);
199 |     if (mode == DECRYPT) {
200 |         mbedtls_aes_setkey_dec(&ctx, key.data(), 128);
201 |     } else {
202 |         mbedtls_aes_setkey_enc(&ctx, key.data(), 128);
203 |     }
204 |     mbedtls_aes_crypt_cbc(&ctx, mode, size, iv.data(), src, dst);
205 |     mbedtls_aes_free(&ctx);
206 | }
207 | 
208 | void SaveDataFactory::encode() {
209 |     // ver 0 save is plaintext
210 |     if (m_version == 0) {
211 |         std::memcpy(m_saveData_encoded.get(), m_saveData.get(), m_fileSize_encoded);
212 |         return;
213 |     }
214 | 
215 |     std::memcpy(m_saveData_encoded.get(), m_saveData.get(), HEADER_SIZE);
216 | 
217 |     // gen random iv and key seed
218 |     randBytes((uint8_t*)m_saveFooter, sizeof(m_saveFooter->iv) + sizeof(m_saveFooter->keySeed));
219 | 
220 |     std::array<uint8_t, 0x10> iv = m_saveFooter->iv;
221 |     SeedRand keyRNG(m_saveFooter->keySeed);
222 | 
223 |     if (m_version == 7 or m_version == 8) {
224 |         auto p_tmpOriginalBody = std::make_unique<uint8_t[]>(m_bodySize);
225 |         std::memcpy(p_tmpOriginalBody.get(), m_saveBody, m_bodySize);
226 | 
227 |         shuffleBody(SHUFFLE, DECODED_BUFF);
228 |         cryptBlock(m_saveBody_encoded, m_saveBody, m_bodySize, iv, ENCRYPT, keyRNG);
229 | 
230 |         std::memcpy(m_saveBody, p_tmpOriginalBody.get(), m_bodySize);
231 | 
232 |     } else {
233 |         cryptBlock(m_saveBody_encoded, m_saveBody, m_bodySize, iv, ENCRYPT, keyRNG);
234 |     }
235 | 
236 |     if (m_version == 4 or m_version == 7 or m_version == 8) {
237 |         shuffleBody(SHUFFLE, ENCODED_BUFF);
238 |     }
239 | 
240 |     std::array<uint8_t, 0x10> cmacKey = getKey(keyRNG);
241 |     mbedtls_cipher_info_t cipher_info = *mbedtls_cipher_info_from_type(MBEDTLS_CIPHER_AES_128_ECB);
242 |     mbedtls_cipher_cmac(&cipher_info, cmacKey.data(), 128, m_saveBody, m_bodySize, m_saveFooter->mac.data());
243 | }
244 | 
245 | void SaveDataFactory::decode() {
246 |     // copy header
247 |     std::memcpy(m_saveData.get(), m_saveData_encoded.get(), HEADER_SIZE);
248 | 
249 |     if (m_version == 4 or m_version == 7 or m_version == 8) {
250 |         shuffleBody(UNSHUFFLE, ENCODED_BUFF);
251 |     }
252 | 
253 |     std::array<uint8_t, 0x10> iv = m_saveFooter->iv;
254 |     SeedRand keyRNG(m_saveFooter->keySeed);
255 | 
256 |     cryptBlock(m_saveBody, m_saveBody_encoded, m_bodySize, iv, DECRYPT, keyRNG);
257 | 
258 |     if (m_version == 7 or m_version == 8) {
259 |         shuffleBody(UNSHUFFLE, DECODED_BUFF);
260 |     }
261 | 
262 |     std::array<uint8_t, 0x10> calced_mac;
263 |     std::array<uint8_t, 0x10> cmacKey = getKey(keyRNG);
264 |     mbedtls_cipher_info_t cipher_info = *mbedtls_cipher_info_from_type(MBEDTLS_CIPHER_AES_128_ECB);
265 |     mbedtls_cipher_cmac(&cipher_info, cmacKey.data(), 128, m_saveBody, m_bodySize, calced_mac.data());
266 | 
267 |     if (m_saveFooter->mac != calced_mac) {
268 |         throw DecodeFailToVerify();
269 |     }
270 | }
271 | 
272 | void SaveDataFactory::updateCRC() { *(uint32_t*)&m_saveData[0x8] = crc32(0L, &m_saveData[HEADER_SIZE], m_bodySize); }
273 | 
274 | void SaveDataFactory::shuffleBody(ShuffleMode mode, ShuffleBuffer targetBuff) {
275 |     auto p_tmpBodyBuffer = std::make_unique<uint8_t[]>(m_bodySize);
276 |     uint8_t* dstBodyBuffer = targetBuff == ENCODED_BUFF ? m_saveBody_encoded : m_saveBody;
277 |     uint32_t* crc = targetBuff == ENCODED_BUFF ? (uint32_t*)&m_saveData_encoded[0x8] : (uint32_t*)&m_saveData[0x8];
278 | 
279 |     std::memcpy(p_tmpBodyBuffer.get(), dstBodyBuffer, m_bodySize);
280 | 
281 |     uint32_t shuffleSeed;
282 |     if (m_version == 8) {
283 |         shuffleSeed = reverseBitsU32(*crc);
284 |         if (targetBuff != ENCODED_BUFF) {
285 |             shuffleSeed = ~shuffleSeed;
286 |         }
287 |     } else {
288 |         shuffleSeed = *crc;
289 |     }
290 | 
291 |     std::vector<ShuffleBlock> shuffleBlocks = getShuffleBlocks(m_bodySize, shuffleSeed);
292 | 
293 |     for (size_t i = 0; i < shuffleBlocks.size(); i++) {
294 |         if (m_version == 8) {
295 |             size_t block_size = shuffleBlocks[i].block_size;
296 |             SeedRand blockCryptRNG(block_size);
297 |             std::array<uint8_t, 0x10> iv = m_saveFooter->iv;
298 |             *(uint64_t*)&iv[0] = blockCryptRNG.getU64();
299 |             *(uint64_t*)&iv[8] = blockCryptRNG.getU64();
300 |             if (mode == SHUFFLE) {
301 |                 cryptBlock(&dstBodyBuffer[shuffleBlocks[i].shuffled_offset],
302 |                            &p_tmpBodyBuffer[shuffleBlocks[i].unshuffled_offset], block_size, iv, ENCRYPT,
303 |                            blockCryptRNG);
304 |             } else {
305 |                 cryptBlock(&dstBodyBuffer[shuffleBlocks[i].unshuffled_offset],
306 |                            &p_tmpBodyBuffer[shuffleBlocks[i].shuffled_offset], block_size, iv, DECRYPT, blockCryptRNG);
307 |             }
308 |         } else {
309 |             if (mode == SHUFFLE) {
310 |                 std::memcpy(&dstBodyBuffer[shuffleBlocks[i].shuffled_offset],
311 |                             &p_tmpBodyBuffer[shuffleBlocks[i].unshuffled_offset], shuffleBlocks[i].block_size);
312 |             } else {
313 |                 std::memcpy(&dstBodyBuffer[shuffleBlocks[i].unshuffled_offset],
314 |                             &p_tmpBodyBuffer[shuffleBlocks[i].shuffled_offset], shuffleBlocks[i].block_size);
315 |             }
316 |         }
317 |     }
318 | }
319 | 
320 | std::vector<SaveDataFactory::ShuffleBlock> SaveDataFactory::getShuffleBlocks(size_t total_size, uint32_t seed) {
321 |     SeedRand RNG(seed);
322 |     size_t min_block_size = total_size / 0x10;
323 |     size_t max_block_size = min_block_size * 2;
324 | 
325 |     std::vector<size_t> block_indices;
326 |     std::vector<size_t> block_sizes;
327 |     std::vector<size_t> unshuffled_offsets;
328 |     size_t cur_offset = 0;
329 |     size_t cur_block_idx = 0;
330 |     while (total_size - cur_offset > min_block_size) {
331 |         // annoyed squid sound
332 |         if (max_block_size > total_size - cur_offset) {
333 |             max_block_size = total_size - cur_offset;
334 |         }
335 | 
336 |         uint64_t rand_num = RNG.getU32();
337 |         size_t block_size;
338 |         if (m_version == 8) {
339 |             block_size = ((((max_block_size & 0xFFFFFFF0) - (min_block_size & 0xFFFFFFF0) + 1) * rand_num >> 32) +
340 |                           (min_block_size & 0xFFFFFFF0)) &
341 |                          0xFFFFFFF0;
342 |         } else {
343 |             block_size = ((max_block_size - min_block_size + 1) * rand_num >> 32) + min_block_size;
344 |         }
345 | 
346 |         block_indices.push_back(cur_block_idx);
347 |         block_sizes.push_back(block_size);
348 |         unshuffled_offsets.push_back(cur_offset);
349 | 
350 |         cur_offset += block_size;
351 |         cur_block_idx++;
352 |     }
353 |     // add last block if needed?
354 |     if (total_size > cur_offset) {
355 |         block_indices.push_back(cur_block_idx);
356 |         block_sizes.push_back(total_size - cur_offset);
357 |         unshuffled_offsets.push_back(cur_offset);
358 |     }
359 | 
360 |     uint64_t remaining_blocks_to_shuffle = block_indices.size();
361 |     while (remaining_blocks_to_shuffle > 1) {
362 |         size_t switch_to_idx = remaining_blocks_to_shuffle - 1;
363 |         size_t switch_from_idx = remaining_blocks_to_shuffle * RNG.getU32() >> 0x20;
364 |         size_t to_back = block_indices[switch_from_idx];
365 |         block_indices[switch_from_idx] = block_indices[switch_to_idx];
366 |         block_indices[switch_to_idx] = to_back;
367 |         remaining_blocks_to_shuffle--;
368 |     }
369 | 
370 |     std::vector<ShuffleBlock> shuffle_blocks;
371 |     size_t cur_shuffled_offset = 0;
372 |     for (size_t i = 0; i < block_indices.size(); i++) {
373 |         shuffle_blocks.push_back(
374 |             {block_sizes[block_indices[i]], unshuffled_offsets[block_indices[i]], cur_shuffled_offset});
375 |         cur_shuffled_offset += block_sizes[block_indices[i]];
376 |     }
377 |     return shuffle_blocks;
378 | }
379 | 
380 | // used in save encoding
381 | int SaveDataFactory::randBytes(uint8_t* output, const size_t output_len) {
382 |     int ret;
383 | #ifndef __SWITCH__
384 |     mbedtls_ctr_drbg_context ctr_drbg;
385 |     mbedtls_entropy_context entropy;
386 |     mbedtls_entropy_init(&entropy);
387 |     mbedtls_ctr_drbg_init(&ctr_drbg);
388 | 
389 |     const char* pers = "Flow best waifu";
390 | 
391 |     ret = mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy, (unsigned char*)pers, strlen(pers));
392 |     if (ret != 0) {
393 |         return ret;
394 |     }
395 |     ret = mbedtls_ctr_drbg_random(&ctr_drbg, output, output_len);
396 | #else
397 |     if ((ret = csrngInitialize()) != 0) {
398 |         return ret;
399 |     }
400 |     ret = csrngGetRandomBytes(output, output_len);
401 |     csrngExit();
402 | #endif
403 |     return ret;
404 | }
405 | 
406 | uint32_t SaveDataFactory::reverseBitsU32(uint32_t value) {
407 |     value = ((value << 1) & 0xAAAAAAAA) | ((value >> 1) & 0x55555555);
408 |     value = ((value << 2) & 0xCCCCCCCC) | ((value >> 2) & 0x33333333);
409 |     value = ((value << 4) & 0xF0F0F0F0) | ((value >> 4) & 0x0F0F0F0F);
410 |     value = ((value << 8) & 0xFF00FF00) | ((value >> 8) & 0x00FF00FF);
411 |     value = ((value << 16) & 0xFFFF0000) | ((value >> 16) & 0x0000FFFF);
412 |     return value;
413 | }
414 | 
415 | const uint8_t* SaveDataFactory::getSaveDecodedPtr() { return m_saveData.get(); }
416 | 
417 | const uint8_t* SaveDataFactory::getSaveEncodedPtr() {
418 |     encode();
419 |     return m_saveData_encoded.get();
420 | }
421 | 
422 | size_t SaveDataFactory::getDecodedSaveFileSize() { return HEADER_SIZE + m_bodySize; }
423 | size_t SaveDataFactory::getEncodedSaveFileSize() { return m_fileSize_encoded; }
424 | 
425 | int SaveDataFactory::getSaveVersion() { return m_version; }
426 | 
427 | SaveDataFactory::EncodeState SaveDataFactory::getInitialEncodeState() { return m_initial_encodeState; }
428 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------