From 1093fe7691115f3316dcf41adba9608b45e71527 Mon Sep 17 00:00:00 2001 From: Alex Hauser Date: Wed, 11 Dec 2019 20:54:24 +0100 Subject: [PATCH] Initial source commit --- Blowfish-Source/blowfish.c | 353 ++ Blowfish-Source/blowfish.h | 24 + Blowfish-Source/makefile | 27 + Lodepng-Source/lodepng.c | 5992 ++++++++++++++++++++++++++++++ Lodepng-Source/lodepng.h | 1930 ++++++++++ Lodepng-Source/makefile | 27 + PHP-EXT-Source/config.m4 | 7 + PHP-EXT-Source/sspphp.c | 244 ++ PHP-EXT-Source/sspphp.h | 17 + SSP-API-Demo/.sspapi.cfg | 21 + SSP-API-Demo/DebugFilter.txt | 5 + SSP-API-Demo/auth.index.php | 133 + SSP-API-Demo/rf.sh | 5 + SSP-API-Demo/rh.sh | 5 + SSP-API-Demo/rx.sh | 5 + SSP-API-Demo/sqrl.index.php | 151 + SSP-API-Demo/ssp.server.crt | 22 + SSP-API-Demo/ssp.server.key | 29 + SSP-API-Demo/test.index.php | 79 + SSP-API-Demo/web.server.crt | 22 + SSP-API-Demo/web.server.key | 29 + SSP-API-Source/base64url.c | 198 + SSP-API-Source/browser.c | 533 +++ SSP-API-Source/client.c | 1128 ++++++ SSP-API-Source/configdata.c | 519 +++ SSP-API-Source/criticalsection.c | 87 + SSP-API-Source/crypto.c | 105 + SSP-API-Source/database.c | 1247 +++++++ SSP-API-Source/dbglog.c | 211 ++ SSP-API-Source/dbglog.h | 45 + SSP-API-Source/global.c | 197 + SSP-API-Source/global.h | 575 +++ SSP-API-Source/handler-mbedtls.c | 650 ++++ SSP-API-Source/handler-openssl.c | 382 ++ SSP-API-Source/handler.c | 118 + SSP-API-Source/makefile | 74 + SSP-API-Source/pendingauths.c | 504 +++ SSP-API-Source/qrcode.c | 107 + SSP-API-Source/response.c | 146 + SSP-API-Source/server.c | 501 +++ SSP-API-Source/sqtypes.h | 48 + SSP-API-Source/sspapi.c | 256 ++ SSP-API-Source/sspapi.h | 22 + SSP-API-Source/sspmain.c | 338 ++ SSP-API-Source/utils.c | 573 +++ install.html | 446 +++ install.sh | 355 ++ 47 files changed, 18492 insertions(+) create mode 100644 Blowfish-Source/blowfish.c create mode 100644 Blowfish-Source/blowfish.h create mode 100644 Blowfish-Source/makefile create mode 100644 Lodepng-Source/lodepng.c create mode 100644 Lodepng-Source/lodepng.h create mode 100644 Lodepng-Source/makefile create mode 100644 PHP-EXT-Source/config.m4 create mode 100644 PHP-EXT-Source/sspphp.c create mode 100644 PHP-EXT-Source/sspphp.h create mode 100644 SSP-API-Demo/.sspapi.cfg create mode 100644 SSP-API-Demo/DebugFilter.txt create mode 100644 SSP-API-Demo/auth.index.php create mode 100644 SSP-API-Demo/rf.sh create mode 100644 SSP-API-Demo/rh.sh create mode 100644 SSP-API-Demo/rx.sh create mode 100644 SSP-API-Demo/sqrl.index.php create mode 100644 SSP-API-Demo/ssp.server.crt create mode 100644 SSP-API-Demo/ssp.server.key create mode 100644 SSP-API-Demo/test.index.php create mode 100644 SSP-API-Demo/web.server.crt create mode 100644 SSP-API-Demo/web.server.key create mode 100644 SSP-API-Source/base64url.c create mode 100644 SSP-API-Source/browser.c create mode 100644 SSP-API-Source/client.c create mode 100644 SSP-API-Source/configdata.c create mode 100644 SSP-API-Source/criticalsection.c create mode 100644 SSP-API-Source/crypto.c create mode 100644 SSP-API-Source/database.c create mode 100644 SSP-API-Source/dbglog.c create mode 100644 SSP-API-Source/dbglog.h create mode 100644 SSP-API-Source/global.c create mode 100644 SSP-API-Source/global.h create mode 100644 SSP-API-Source/handler-mbedtls.c create mode 100644 SSP-API-Source/handler-openssl.c create mode 100644 SSP-API-Source/handler.c create mode 100644 SSP-API-Source/makefile create mode 100644 SSP-API-Source/pendingauths.c create mode 100644 SSP-API-Source/qrcode.c create mode 100644 SSP-API-Source/response.c create mode 100644 SSP-API-Source/server.c create mode 100644 SSP-API-Source/sqtypes.h create mode 100644 SSP-API-Source/sspapi.c create mode 100644 SSP-API-Source/sspapi.h create mode 100644 SSP-API-Source/sspmain.c create mode 100644 SSP-API-Source/utils.c create mode 100644 install.html create mode 100755 install.sh diff --git a/Blowfish-Source/blowfish.c b/Blowfish-Source/blowfish.c new file mode 100644 index 0000000..48b65f1 --- /dev/null +++ b/Blowfish-Source/blowfish.c @@ -0,0 +1,353 @@ + +// blowfish.c + +// Written by Andrew Carter (2008) +#include +#include +#include +#include "blowfish.h" + +#define BLOWFISH_F(x) \ + (((ctx->sbox[0][x >> 24] + ctx->sbox[1][(x >> 16) & 0xFF]) \ + ^ ctx->sbox[2][(x >> 8) & 0xFF]) + ctx->sbox[3][x & 0xFF]) + +const BF_ULONG ORIG_P[18] = { + 0x243F6A88, 0x85A308D3, 0x13198A2E, 0x03707344, + 0xA4093822, 0x299F31D0, 0x082EFA98, 0xEC4E6C89, + 0x452821E6, 0x38D01377, 0xBE5466CF, 0x34E90C6C, + 0xC0AC29B7, 0xC97C50DD, 0x3F84D5B5, 0xB5470917, + 0x9216D5D9, 0x8979FB1B +}; + +const BF_ULONG ORIG_S[4][256] = { + { 0xD1310BA6, 0x98DFB5AC, 0x2FFD72DB, 0xD01ADFB7, + 0xB8E1AFED, 0x6A267E96, 0xBA7C9045, 0xF12C7F99, + 0x24A19947, 0xB3916CF7, 0x0801F2E2, 0x858EFC16, + 0x636920D8, 0x71574E69, 0xA458FEA3, 0xF4933D7E, + 0x0D95748F, 0x728EB658, 0x718BCD58, 0x82154AEE, + 0x7B54A41D, 0xC25A59B5, 0x9C30D539, 0x2AF26013, + 0xC5D1B023, 0x286085F0, 0xCA417918, 0xB8DB38EF, + 0x8E79DCB0, 0x603A180E, 0x6C9E0E8B, 0xB01E8A3E, + 0xD71577C1, 0xBD314B27, 0x78AF2FDA, 0x55605C60, + 0xE65525F3, 0xAA55AB94, 0x57489862, 0x63E81440, + 0x55CA396A, 0x2AAB10B6, 0xB4CC5C34, 0x1141E8CE, + 0xA15486AF, 0x7C72E993, 0xB3EE1411, 0x636FBC2A, + 0x2BA9C55D, 0x741831F6, 0xCE5C3E16, 0x9B87931E, + 0xAFD6BA33, 0x6C24CF5C, 0x7A325381, 0x28958677, + 0x3B8F4898, 0x6B4BB9AF, 0xC4BFE81B, 0x66282193, + 0x61D809CC, 0xFB21A991, 0x487CAC60, 0x5DEC8032, + 0xEF845D5D, 0xE98575B1, 0xDC262302, 0xEB651B88, + 0x23893E81, 0xD396ACC5, 0x0F6D6FF3, 0x83F44239, + 0x2E0B4482, 0xA4842004, 0x69C8F04A, 0x9E1F9B5E, + 0x21C66842, 0xF6E96C9A, 0x670C9C61, 0xABD388F0, + 0x6A51A0D2, 0xD8542F68, 0x960FA728, 0xAB5133A3, + 0x6EEF0B6C, 0x137A3BE4, 0xBA3BF050, 0x7EFB2A98, + 0xA1F1651D, 0x39AF0176, 0x66CA593E, 0x82430E88, + 0x8CEE8619, 0x456F9FB4, 0x7D84A5C3, 0x3B8B5EBE, + 0xE06F75D8, 0x85C12073, 0x401A449F, 0x56C16AA6, + 0x4ED3AA62, 0x363F7706, 0x1BFEDF72, 0x429B023D, + 0x37D0D724, 0xD00A1248, 0xDB0FEAD3, 0x49F1C09B, + 0x075372C9, 0x80991B7B, 0x25D479D8, 0xF6E8DEF7, + 0xE3FE501A, 0xB6794C3B, 0x976CE0BD, 0x04C006BA, + 0xC1A94FB6, 0x409F60C4, 0x5E5C9EC2, 0x196A2463, + 0x68FB6FAF, 0x3E6C53B5, 0x1339B2EB, 0x3B52EC6F, + 0x6DFC511F, 0x9B30952C, 0xCC814544, 0xAF5EBD09, + 0xBEE3D004, 0xDE334AFD, 0x660F2807, 0x192E4BB3, + 0xC0CBA857, 0x45C8740F, 0xD20B5F39, 0xB9D3FBDB, + 0x5579C0BD, 0x1A60320A, 0xD6A100C6, 0x402C7279, + 0x679F25FE, 0xFB1FA3CC, 0x8EA5E9F8, 0xDB3222F8, + 0x3C7516DF, 0xFD616B15, 0x2F501EC8, 0xAD0552AB, + 0x323DB5FA, 0xFD238760, 0x53317B48, 0x3E00DF82, + 0x9E5C57BB, 0xCA6F8CA0, 0x1A87562E, 0xDF1769DB, + 0xD542A8F6, 0x287EFFC3, 0xAC6732C6, 0x8C4F5573, + 0x695B27B0, 0xBBCA58C8, 0xE1FFA35D, 0xB8F011A0, + 0x10FA3D98, 0xFD2183B8, 0x4AFCB56C, 0x2DD1D35B, + 0x9A53E479, 0xB6F84565, 0xD28E49BC, 0x4BFB9790, + 0xE1DDF2DA, 0xA4CB7E33, 0x62FB1341, 0xCEE4C6E8, + 0xEF20CADA, 0x36774C01, 0xD07E9EFE, 0x2BF11FB4, + 0x95DBDA4D, 0xAE909198, 0xEAAD8E71, 0x6B93D5A0, + 0xD08ED1D0, 0xAFC725E0, 0x8E3C5B2F, 0x8E7594B7, + 0x8FF6E2FB, 0xF2122B64, 0x8888B812, 0x900DF01C, + 0x4FAD5EA0, 0x688FC31C, 0xD1CFF191, 0xB3A8C1AD, + 0x2F2F2218, 0xBE0E1777, 0xEA752DFE, 0x8B021FA1, + 0xE5A0CC0F, 0xB56F74E8, 0x18ACF3D6, 0xCE89E299, + 0xB4A84FE0, 0xFD13E0B7, 0x7CC43B81, 0xD2ADA8D9, + 0x165FA266, 0x80957705, 0x93CC7314, 0x211A1477, + 0xE6AD2065, 0x77B5FA86, 0xC75442F5, 0xFB9D35CF, + 0xEBCDAF0C, 0x7B3E89A0, 0xD6411BD3, 0xAE1E7E49, + 0x00250E2D, 0x2071B35E, 0x226800BB, 0x57B8E0AF, + 0x2464369B, 0xF009B91E, 0x5563911D, 0x59DFA6AA, + 0x78C14389, 0xD95A537F, 0x207D5BA2, 0x02E5B9C5, + 0x83260376, 0x6295CFA9, 0x11C81968, 0x4E734A41, + 0xB3472DCA, 0x7B14A94A, 0x1B510052, 0x9A532915, + 0xD60F573F, 0xBC9BC6E4, 0x2B60A476, 0x81E67400, + 0x08BA6FB5, 0x571BE91F, 0xF296EC6B, 0x2A0DD915, + 0xB6636521, 0xE7B9F9B6, 0xFF34052E, 0xC5855664, + 0x53B02D5D, 0xA99F8FA1, 0x08BA4799, 0x6E85076A }, + { 0x4B7A70E9, 0xB5B32944, 0xDB75092E, 0xC4192623, + 0xAD6EA6B0, 0x49A7DF7D, 0x9CEE60B8, 0x8FEDB266, + 0xECAA8C71, 0x699A17FF, 0x5664526C, 0xC2B19EE1, + 0x193602A5, 0x75094C29, 0xA0591340, 0xE4183A3E, + 0x3F54989A, 0x5B429D65, 0x6B8FE4D6, 0x99F73FD6, + 0xA1D29C07, 0xEFE830F5, 0x4D2D38E6, 0xF0255DC1, + 0x4CDD2086, 0x8470EB26, 0x6382E9C6, 0x021ECC5E, + 0x09686B3F, 0x3EBAEFC9, 0x3C971814, 0x6B6A70A1, + 0x687F3584, 0x52A0E286, 0xB79C5305, 0xAA500737, + 0x3E07841C, 0x7FDEAE5C, 0x8E7D44EC, 0x5716F2B8, + 0xB03ADA37, 0xF0500C0D, 0xF01C1F04, 0x0200B3FF, + 0xAE0CF51A, 0x3CB574B2, 0x25837A58, 0xDC0921BD, + 0xD19113F9, 0x7CA92FF6, 0x94324773, 0x22F54701, + 0x3AE5E581, 0x37C2DADC, 0xC8B57634, 0x9AF3DDA7, + 0xA9446146, 0x0FD0030E, 0xECC8C73E, 0xA4751E41, + 0xE238CD99, 0x3BEA0E2F, 0x3280BBA1, 0x183EB331, + 0x4E548B38, 0x4F6DB908, 0x6F420D03, 0xF60A04BF, + 0x2CB81290, 0x24977C79, 0x5679B072, 0xBCAF89AF, + 0xDE9A771F, 0xD9930810, 0xB38BAE12, 0xDCCF3F2E, + 0x5512721F, 0x2E6B7124, 0x501ADDE6, 0x9F84CD87, + 0x7A584718, 0x7408DA17, 0xBC9F9ABC, 0xE94B7D8C, + 0xEC7AEC3A, 0xDB851DFA, 0x63094366, 0xC464C3D2, + 0xEF1C1847, 0x3215D908, 0xDD433B37, 0x24C2BA16, + 0x12A14D43, 0x2A65C451, 0x50940002, 0x133AE4DD, + 0x71DFF89E, 0x10314E55, 0x81AC77D6, 0x5F11199B, + 0x043556F1, 0xD7A3C76B, 0x3C11183B, 0x5924A509, + 0xF28FE6ED, 0x97F1FBFA, 0x9EBABF2C, 0x1E153C6E, + 0x86E34570, 0xEAE96FB1, 0x860E5E0A, 0x5A3E2AB3, + 0x771FE71C, 0x4E3D06FA, 0x2965DCB9, 0x99E71D0F, + 0x803E89D6, 0x5266C825, 0x2E4CC978, 0x9C10B36A, + 0xC6150EBA, 0x94E2EA78, 0xA5FC3C53, 0x1E0A2DF4, + 0xF2F74EA7, 0x361D2B3D, 0x1939260F, 0x19C27960, + 0x5223A708, 0xF71312B6, 0xEBADFE6E, 0xEAC31F66, + 0xE3BC4595, 0xA67BC883, 0xB17F37D1, 0x018CFF28, + 0xC332DDEF, 0xBE6C5AA5, 0x65582185, 0x68AB9802, + 0xEECEA50F, 0xDB2F953B, 0x2AEF7DAD, 0x5B6E2F84, + 0x1521B628, 0x29076170, 0xECDD4775, 0x619F1510, + 0x13CCA830, 0xEB61BD96, 0x0334FE1E, 0xAA0363CF, + 0xB5735C90, 0x4C70A239, 0xD59E9E0B, 0xCBAADE14, + 0xEECC86BC, 0x60622CA7, 0x9CAB5CAB, 0xB2F3846E, + 0x648B1EAF, 0x19BDF0CA, 0xA02369B9, 0x655ABB50, + 0x40685A32, 0x3C2AB4B3, 0x319EE9D5, 0xC021B8F7, + 0x9B540B19, 0x875FA099, 0x95F7997E, 0x623D7DA8, + 0xF837889A, 0x97E32D77, 0x11ED935F, 0x16681281, + 0x0E358829, 0xC7E61FD6, 0x96DEDFA1, 0x7858BA99, + 0x57F584A5, 0x1B227263, 0x9B83C3FF, 0x1AC24696, + 0xCDB30AEB, 0x532E3054, 0x8FD948E4, 0x6DBC3128, + 0x58EBF2EF, 0x34C6FFEA, 0xFE28ED61, 0xEE7C3C73, + 0x5D4A14D9, 0xE864B7E3, 0x42105D14, 0x203E13E0, + 0x45EEE2B6, 0xA3AAABEA, 0xDB6C4F15, 0xFACB4FD0, + 0xC742F442, 0xEF6ABBB5, 0x654F3B1D, 0x41CD2105, + 0xD81E799E, 0x86854DC7, 0xE44B476A, 0x3D816250, + 0xCF62A1F2, 0x5B8D2646, 0xFC8883A0, 0xC1C7B6A3, + 0x7F1524C3, 0x69CB7492, 0x47848A0B, 0x5692B285, + 0x095BBF00, 0xAD19489D, 0x1462B174, 0x23820E00, + 0x58428D2A, 0x0C55F5EA, 0x1DADF43E, 0x233F7061, + 0x3372F092, 0x8D937E41, 0xD65FECF1, 0x6C223BDB, + 0x7CDE3759, 0xCBEE7460, 0x4085F2A7, 0xCE77326E, + 0xA6078084, 0x19F8509E, 0xE8EFD855, 0x61D99735, + 0xA969A7AA, 0xC50C06C2, 0x5A04ABFC, 0x800BCADC, + 0x9E447A2E, 0xC3453484, 0xFDD56705, 0x0E1E9EC9, + 0xDB73DBD3, 0x105588CD, 0x675FDA79, 0xE3674340, + 0xC5C43465, 0x713E38D8, 0x3D28F89E, 0xF16DFF20, + 0x153E21E7, 0x8FB03D4A, 0xE6E39F2B, 0xDB83ADF7 }, + { 0xE93D5A68, 0x948140F7, 0xF64C261C, 0x94692934, + 0x411520F7, 0x7602D4F7, 0xBCF46B2E, 0xD4A20068, + 0xD4082471, 0x3320F46A, 0x43B7D4B7, 0x500061AF, + 0x1E39F62E, 0x97244546, 0x14214F74, 0xBF8B8840, + 0x4D95FC1D, 0x96B591AF, 0x70F4DDD3, 0x66A02F45, + 0xBFBC09EC, 0x03BD9785, 0x7FAC6DD0, 0x31CB8504, + 0x96EB27B3, 0x55FD3941, 0xDA2547E6, 0xABCA0A9A, + 0x28507825, 0x530429F4, 0x0A2C86DA, 0xE9B66DFB, + 0x68DC1462, 0xD7486900, 0x680EC0A4, 0x27A18DEE, + 0x4F3FFEA2, 0xE887AD8C, 0xB58CE006, 0x7AF4D6B6, + 0xAACE1E7C, 0xD3375FEC, 0xCE78A399, 0x406B2A42, + 0x20FE9E35, 0xD9F385B9, 0xEE39D7AB, 0x3B124E8B, + 0x1DC9FAF7, 0x4B6D1856, 0x26A36631, 0xEAE397B2, + 0x3A6EFA74, 0xDD5B4332, 0x6841E7F7, 0xCA7820FB, + 0xFB0AF54E, 0xD8FEB397, 0x454056AC, 0xBA489527, + 0x55533A3A, 0x20838D87, 0xFE6BA9B7, 0xD096954B, + 0x55A867BC, 0xA1159A58, 0xCCA92963, 0x99E1DB33, + 0xA62A4A56, 0x3F3125F9, 0x5EF47E1C, 0x9029317C, + 0xFDF8E802, 0x04272F70, 0x80BB155C, 0x05282CE3, + 0x95C11548, 0xE4C66D22, 0x48C1133F, 0xC70F86DC, + 0x07F9C9EE, 0x41041F0F, 0x404779A4, 0x5D886E17, + 0x325F51EB, 0xD59BC0D1, 0xF2BCC18F, 0x41113564, + 0x257B7834, 0x602A9C60, 0xDFF8E8A3, 0x1F636C1B, + 0x0E12B4C2, 0x02E1329E, 0xAF664FD1, 0xCAD18115, + 0x6B2395E0, 0x333E92E1, 0x3B240B62, 0xEEBEB922, + 0x85B2A20E, 0xE6BA0D99, 0xDE720C8C, 0x2DA2F728, + 0xD0127845, 0x95B794FD, 0x647D0862, 0xE7CCF5F0, + 0x5449A36F, 0x877D48FA, 0xC39DFD27, 0xF33E8D1E, + 0x0A476341, 0x992EFF74, 0x3A6F6EAB, 0xF4F8FD37, + 0xA812DC60, 0xA1EBDDF8, 0x991BE14C, 0xDB6E6B0D, + 0xC67B5510, 0x6D672C37, 0x2765D43B, 0xDCD0E804, + 0xF1290DC7, 0xCC00FFA3, 0xB5390F92, 0x690FED0B, + 0x667B9FFB, 0xCEDB7D9C, 0xA091CF0B, 0xD9155EA3, + 0xBB132F88, 0x515BAD24, 0x7B9479BF, 0x763BD6EB, + 0x37392EB3, 0xCC115979, 0x8026E297, 0xF42E312D, + 0x6842ADA7, 0xC66A2B3B, 0x12754CCC, 0x782EF11C, + 0x6A124237, 0xB79251E7, 0x06A1BBE6, 0x4BFB6350, + 0x1A6B1018, 0x11CAEDFA, 0x3D25BDD8, 0xE2E1C3C9, + 0x44421659, 0x0A121386, 0xD90CEC6E, 0xD5ABEA2A, + 0x64AF674E, 0xDA86A85F, 0xBEBFE988, 0x64E4C3FE, + 0x9DBC8057, 0xF0F7C086, 0x60787BF8, 0x6003604D, + 0xD1FD8346, 0xF6381FB0, 0x7745AE04, 0xD736FCCC, + 0x83426B33, 0xF01EAB71, 0xB0804187, 0x3C005E5F, + 0x77A057BE, 0xBDE8AE24, 0x55464299, 0xBF582E61, + 0x4E58F48F, 0xF2DDFDA2, 0xF474EF38, 0x8789BDC2, + 0x5366F9C3, 0xC8B38E74, 0xB475F255, 0x46FCD9B9, + 0x7AEB2661, 0x8B1DDF84, 0x846A0E79, 0x915F95E2, + 0x466E598E, 0x20B45770, 0x8CD55591, 0xC902DE4C, + 0xB90BACE1, 0xBB8205D0, 0x11A86248, 0x7574A99E, + 0xB77F19B6, 0xE0A9DC09, 0x662D09A1, 0xC4324633, + 0xE85A1F02, 0x09F0BE8C, 0x4A99A025, 0x1D6EFE10, + 0x1AB93D1D, 0x0BA5A4DF, 0xA186F20F, 0x2868F169, + 0xDCB7DA83, 0x573906FE, 0xA1E2CE9B, 0x4FCD7F52, + 0x50115E01, 0xA70683FA, 0xA002B5C4, 0x0DE6D027, + 0x9AF88C27, 0x773F8641, 0xC3604C06, 0x61A806B5, + 0xF0177A28, 0xC0F586E0, 0x006058AA, 0x30DC7D62, + 0x11E69ED7, 0x2338EA63, 0x53C2DD94, 0xC2C21634, + 0xBBCBEE56, 0x90BCB6DE, 0xEBFC7DA1, 0xCE591D76, + 0x6F05E409, 0x4B7C0188, 0x39720A3D, 0x7C927C24, + 0x86E3725F, 0x724D9DB9, 0x1AC15BB4, 0xD39EB8FC, + 0xED545578, 0x08FCA5B5, 0xD83D7CD3, 0x4DAD0FC4, + 0x1E50EF5E, 0xB161E6F8, 0xA28514D9, 0x6C51133C, + 0x6FD5C7E7, 0x56E14EC4, 0x362ABFCE, 0xDDC6C837, + 0xD79A3234, 0x92638212, 0x670EFA8E, 0x406000E0 }, + { 0x3A39CE37, 0xD3FAF5CF, 0xABC27737, 0x5AC52D1B, + 0x5CB0679E, 0x4FA33742, 0xD3822740, 0x99BC9BBE, + 0xD5118E9D, 0xBF0F7315, 0xD62D1C7E, 0xC700C47B, + 0xB78C1B6B, 0x21A19045, 0xB26EB1BE, 0x6A366EB4, + 0x5748AB2F, 0xBC946E79, 0xC6A376D2, 0x6549C2C8, + 0x530FF8EE, 0x468DDE7D, 0xD5730A1D, 0x4CD04DC6, + 0x2939BBDB, 0xA9BA4650, 0xAC9526E8, 0xBE5EE304, + 0xA1FAD5F0, 0x6A2D519A, 0x63EF8CE2, 0x9A86EE22, + 0xC089C2B8, 0x43242EF6, 0xA51E03AA, 0x9CF2D0A4, + 0x83C061BA, 0x9BE96A4D, 0x8FE51550, 0xBA645BD6, + 0x2826A2F9, 0xA73A3AE1, 0x4BA99586, 0xEF5562E9, + 0xC72FEFD3, 0xF752F7DA, 0x3F046F69, 0x77FA0A59, + 0x80E4A915, 0x87B08601, 0x9B09E6AD, 0x3B3EE593, + 0xE990FD5A, 0x9E34D797, 0x2CF0B7D9, 0x022B8B51, + 0x96D5AC3A, 0x017DA67D, 0xD1CF3ED6, 0x7C7D2D28, + 0x1F9F25CF, 0xADF2B89B, 0x5AD6B472, 0x5A88F54C, + 0xE029AC71, 0xE019A5E6, 0x47B0ACFD, 0xED93FA9B, + 0xE8D3C48D, 0x283B57CC, 0xF8D56629, 0x79132E28, + 0x785F0191, 0xED756055, 0xF7960E44, 0xE3D35E8C, + 0x15056DD4, 0x88F46DBA, 0x03A16125, 0x0564F0BD, + 0xC3EB9E15, 0x3C9057A2, 0x97271AEC, 0xA93A072A, + 0x1B3F6D9B, 0x1E6321F5, 0xF59C66FB, 0x26DCF319, + 0x7533D928, 0xB155FDF5, 0x03563482, 0x8ABA3CBB, + 0x28517711, 0xC20AD9F8, 0xABCC5167, 0xCCAD925F, + 0x4DE81751, 0x3830DC8E, 0x379D5862, 0x9320F991, + 0xEA7A90C2, 0xFB3E7BCE, 0x5121CE64, 0x774FBE32, + 0xA8B6E37E, 0xC3293D46, 0x48DE5369, 0x6413E680, + 0xA2AE0810, 0xDD6DB224, 0x69852DFD, 0x09072166, + 0xB39A460A, 0x6445C0DD, 0x586CDECF, 0x1C20C8AE, + 0x5BBEF7DD, 0x1B588D40, 0xCCD2017F, 0x6BB4E3BB, + 0xDDA26A7E, 0x3A59FF45, 0x3E350A44, 0xBCB4CDD5, + 0x72EACEA8, 0xFA6484BB, 0x8D6612AE, 0xBF3C6F47, + 0xD29BE463, 0x542F5D9E, 0xAEC2771B, 0xF64E6370, + 0x740E0D8D, 0xE75B1357, 0xF8721671, 0xAF537D5D, + 0x4040CB08, 0x4EB4E2CC, 0x34D2466A, 0x0115AF84, + 0xE1B00428, 0x95983A1D, 0x06B89FB4, 0xCE6EA048, + 0x6F3F3B82, 0x3520AB82, 0x011A1D4B, 0x277227F8, + 0x611560B1, 0xE7933FDC, 0xBB3A792B, 0x344525BD, + 0xA08839E1, 0x51CE794B, 0x2F32C9B7, 0xA01FBAC9, + 0xE01CC87E, 0xBCC7D1F6, 0xCF0111C3, 0xA1E8AAC7, + 0x1A908749, 0xD44FBD9A, 0xD0DADECB, 0xD50ADA38, + 0x0339C32A, 0xC6913667, 0x8DF9317C, 0xE0B12B4F, + 0xF79E59B7, 0x43F5BB3A, 0xF2D519FF, 0x27D9459C, + 0xBF97222C, 0x15E6FC2A, 0x0F91FC71, 0x9B941525, + 0xFAE59361, 0xCEB69CEB, 0xC2A86459, 0x12BAA8D1, + 0xB6C1075E, 0xE3056A0C, 0x10D25065, 0xCB03A442, + 0xE0EC6E0E, 0x1698DB3B, 0x4C98A0BE, 0x3278E964, + 0x9F1F9532, 0xE0D392DF, 0xD3A0342B, 0x8971F21E, + 0x1B0A7441, 0x4BA3348C, 0xC5BE7120, 0xC37632D8, + 0xDF359F8D, 0x9B992F2E, 0xE60B6F47, 0x0FE3F11D, + 0xE54CDA54, 0x1EDAD891, 0xCE6279CF, 0xCD3E7E6F, + 0x1618B166, 0xFD2C1D05, 0x848FD2C5, 0xF6FB2299, + 0xF523F357, 0xA6327623, 0x93A83531, 0x56CCCD02, + 0xACF08162, 0x5A75EBB5, 0x6E163697, 0x88D273CC, + 0xDE966292, 0x81B949D0, 0x4C50901B, 0x71C65614, + 0xE6C6C7BD, 0x327A140A, 0x45E1D006, 0xC3F27B9A, + 0xC9AA53FD, 0x62A80F00, 0xBB25BFE2, 0x35BDD2F6, + 0x71126905, 0xB2040222, 0xB6CBCF7C, 0xCD769C2B, + 0x53113EC0, 0x1640E3D3, 0x38ABBD60, 0x2547ADF0, + 0xBA38209C, 0xF746CE76, 0x77AFA1C5, 0x20756060, + 0x85CBFE4E, 0x8AE88DD8, 0x7AAAF9B0, 0x4CF9AA7E, + 0x1948C25C, 0x02FB8A8C, 0x01C36AE4, 0xD6EBE1F9, + 0x90D4F869, 0xA65CDEA0, 0x3F09252D, 0xC208E69F, + 0xB74E6132, 0xCE77E25B, 0x578FDFE3, 0x3AC372E6 } +}; +void blowfish_encryptblock(blowfish_context_t *ctx, BF_ULONG *hi, BF_ULONG *lo) +{ + int i, temp; + + for(i = 0; i < 16; i++) { + *hi ^= ctx->pbox[i]; + *lo ^= BLOWFISH_F(*hi); + temp = *hi, *hi = *lo, *lo = temp; + } + temp = *hi, *hi = *lo, *lo = temp; + + *lo ^= ctx->pbox[16]; + *hi ^= ctx->pbox[17]; +} + +void blowfish_decryptblock(blowfish_context_t *ctx, BF_ULONG *hi, BF_ULONG *lo) +{ + int i, temp; + + for(i = 17; i > 1; i--) { + *hi ^= ctx->pbox[i]; + *lo ^= BLOWFISH_F(*hi); + temp = *hi, *hi = *lo, *lo = temp; + } + temp = *hi, *hi = *lo, *lo = temp; + + *lo ^= ctx->pbox[1]; + *hi ^= ctx->pbox[0]; +} + +void blowfish_initiate(blowfish_context_t *ctx, const void *keyparam, unsigned int keybytes) +{ + keybytes %= 57; + const unsigned char *key = keyparam; + int i, j, k; + BF_ULONG calc; + + for(i = 0; i < 4; i++) + memcpy(ctx->sbox[i], ORIG_S[i], sizeof(ORIG_S[i])); + + memcpy(ctx->pbox, ORIG_P, sizeof(ORIG_P)); + + if(keybytes) { + for(i = 0, j = 0; i < 18; i++) { + for(k = 0, calc = 0; k < 4; k++) { + calc <<= 8, calc |= key[j++]; + if(j == keybytes) + j = 0; + } + ctx->pbox[i] ^= calc; + } + } + + BF_ULONG hi = 0, lo = 0; + + for(i = 0; i < 18; i += 2) { + blowfish_encryptblock(ctx, &hi, &lo); + ctx->pbox[i] = hi; + ctx->pbox[i + 1] = lo; + } + + for(i = 0; i < 4; i++) { + for(j = 0; j < 256; j += 2) { + blowfish_encryptblock(ctx, &hi, &lo); + ctx->sbox[i][j] = hi; + ctx->sbox[i][j + 1] = lo; + } + } +} + +void blowfish_clean(blowfish_context_t *ctx) +{ + memset(ctx, 0, sizeof(blowfish_context_t)); +} diff --git a/Blowfish-Source/blowfish.h b/Blowfish-Source/blowfish.h new file mode 100644 index 0000000..87e33f8 --- /dev/null +++ b/Blowfish-Source/blowfish.h @@ -0,0 +1,24 @@ + +// blowfish.h + +// Written by Andrew Carter (2008) + +#ifndef BLOWFISH_H_ +#define BLOWFISH_H_ + +typedef unsigned int BF_ULONG; + +typedef struct blowfish_context_t_ { + BF_ULONG pbox[256]; + BF_ULONG sbox[4][256]; +} blowfish_context_t; + +void blowfish_encryptblock (blowfish_context_t *ctx, BF_ULONG *hi, BF_ULONG *lo); +void blowfish_decryptblock (blowfish_context_t *ctx, BF_ULONG *hi, BF_ULONG *lo); +void blowfish_initiate (blowfish_context_t *ctx, const void *keyparam, unsigned int keybytes); +void blowfish_clean (blowfish_context_t *ctx); + +//extern const BF_ULONG ORIG_P[18]; +//extern const BF_ULONG ORIG_S[4][256]; + +#endif diff --git a/Blowfish-Source/makefile b/Blowfish-Source/makefile new file mode 100644 index 0000000..303034b --- /dev/null +++ b/Blowfish-Source/makefile @@ -0,0 +1,27 @@ +TARGET = libblowfish.so +LIBS = +CC = gcc -shared -fPIC +CFLAGS = + +.PHONY: clean all default + +default: $(TARGET) +all: default + +OBJECTS = $(patsubst %.c, %.o, $(wildcard *.c)) +HEADERS = $(wildcard *.h) + +%.o: %.c $(HEADERS) + $(CC) -c $(CFLAGS) $< -o $@ + +.PRECIOUS: $(TARGET) $(OBJECTS) + +$(TARGET): $(OBJECTS) + $(CC) $(OBJECTS) -Wall $(LIBS) -o $@ + sudo cp blowfish.h /usr/local/include + sudo cp $(TARGET) /usr/local/lib + sudo ldconfig + +clean: + -rm -f *.o + -rm -f $(TARGET) diff --git a/Lodepng-Source/lodepng.c b/Lodepng-Source/lodepng.c new file mode 100644 index 0000000..90faf40 --- /dev/null +++ b/Lodepng-Source/lodepng.c @@ -0,0 +1,5992 @@ +/* +LodePNG version 20190210 + +Copyright (c) 2005-2019 Lode Vandevenne + +This software is provided 'as-is', without any express or implied +warranty. In no event will the authors be held liable for any damages +arising from the use of this software. + +Permission is granted to anyone to use this software for any purpose, +including commercial applications, and to alter it and redistribute it +freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + + 3. This notice may not be removed or altered from any source + distribution. +*/ + +/* +The manual and changelog are in the header file "lodepng.h" +Rename this file to lodepng.cpp to use it for C++, or to lodepng.c to use it for C. +*/ + +#include "lodepng.h" + +#include /* LONG_MAX */ +#include /* file handling */ +#include /* allocations */ + +#if defined(_MSC_VER) && (_MSC_VER >= 1310) /*Visual Studio: A few warning types are not desired here.*/ +#pragma warning( disable : 4244 ) /*implicit conversions: not warned by gcc -Wall -Wextra and requires too much casts*/ +#pragma warning( disable : 4996 ) /*VS does not like fopen, but fopen_s is not standard C so unusable here*/ +#endif /*_MSC_VER */ + +const char* LODEPNG_VERSION_STRING = "20190210"; + +/* +This source file is built up in the following large parts. The code sections +with the "LODEPNG_COMPILE_" #defines divide this up further in an intermixed way. +-Tools for C and common code for PNG and Zlib +-C Code for Zlib (huffman, deflate, ...) +-C Code for PNG (file format chunks, adam7, PNG filters, color conversions, ...) +-The C++ wrapper around all of the above +*/ + +/*The malloc, realloc and free functions defined here with "lodepng_" in front +of the name, so that you can easily change them to others related to your +platform if needed. Everything else in the code calls these. Pass +-DLODEPNG_NO_COMPILE_ALLOCATORS to the compiler, or comment out +#define LODEPNG_COMPILE_ALLOCATORS in the header, to disable the ones here and +define them in your own project's source files without needing to change +lodepng source code. Don't forget to remove "static" if you copypaste them +from here.*/ + +#ifdef LODEPNG_COMPILE_ALLOCATORS +static void* lodepng_malloc(size_t size) { +#ifdef LODEPNG_MAX_ALLOC + if(size > LODEPNG_MAX_ALLOC) return 0; +#endif + return malloc(size); +} + +static void* lodepng_realloc(void* ptr, size_t new_size) { +#ifdef LODEPNG_MAX_ALLOC + if(new_size > LODEPNG_MAX_ALLOC) return 0; +#endif + return realloc(ptr, new_size); +} + +static void lodepng_free(void* ptr) { + free(ptr); +} +#else /*LODEPNG_COMPILE_ALLOCATORS*/ +void* lodepng_malloc(size_t size); +void* lodepng_realloc(void* ptr, size_t new_size); +void lodepng_free(void* ptr); +#endif /*LODEPNG_COMPILE_ALLOCATORS*/ + +/* ////////////////////////////////////////////////////////////////////////// */ +/* ////////////////////////////////////////////////////////////////////////// */ +/* // Tools for C, and common code for PNG and Zlib. // */ +/* ////////////////////////////////////////////////////////////////////////// */ +/* ////////////////////////////////////////////////////////////////////////// */ + +#define LODEPNG_MAX(a, b) (((a) > (b)) ? (a) : (b)) +#define LODEPNG_MIN(a, b) (((a) < (b)) ? (a) : (b)) + +/* +Often in case of an error a value is assigned to a variable and then it breaks +out of a loop (to go to the cleanup phase of a function). This macro does that. +It makes the error handling code shorter and more readable. + +Example: if(!uivector_resizev(&frequencies_ll, 286, 0)) ERROR_BREAK(83); +*/ +#define CERROR_BREAK(errorvar, code){\ + errorvar = code;\ + break;\ +} + +/*version of CERROR_BREAK that assumes the common case where the error variable is named "error"*/ +#define ERROR_BREAK(code) CERROR_BREAK(error, code) + +/*Set error var to the error code, and return it.*/ +#define CERROR_RETURN_ERROR(errorvar, code){\ + errorvar = code;\ + return code;\ +} + +/*Try the code, if it returns error, also return the error.*/ +#define CERROR_TRY_RETURN(call){\ + unsigned error = call;\ + if(error) return error;\ +} + +/*Set error var to the error code, and return from the void function.*/ +#define CERROR_RETURN(errorvar, code){\ + errorvar = code;\ + return;\ +} + +/* +About uivector, ucvector and string: +-All of them wrap dynamic arrays or text strings in a similar way. +-LodePNG was originally written in C++. The vectors replace the std::vectors that were used in the C++ version. +-The string tools are made to avoid problems with compilers that declare things like strncat as deprecated. +-They're not used in the interface, only internally in this file as static functions. +-As with many other structs in this file, the init and cleanup functions serve as ctor and dtor. +*/ + +#ifdef LODEPNG_COMPILE_ZLIB +/*dynamic vector of unsigned ints*/ +typedef struct uivector { + unsigned* data; + size_t size; /*size in number of unsigned longs*/ + size_t allocsize; /*allocated size in bytes*/ +} uivector; + +static void uivector_cleanup(void* p) { + ((uivector*)p)->size = ((uivector*)p)->allocsize = 0; + lodepng_free(((uivector*)p)->data); + ((uivector*)p)->data = NULL; +} + +/*returns 1 if success, 0 if failure ==> nothing done*/ +static unsigned uivector_reserve(uivector* p, size_t allocsize) { + if(allocsize > p->allocsize) { + size_t newsize = (allocsize > p->allocsize * 2) ? allocsize : (allocsize * 3 / 2); + void* data = lodepng_realloc(p->data, newsize); + if(data) { + p->allocsize = newsize; + p->data = (unsigned*)data; + } + else return 0; /*error: not enough memory*/ + } + return 1; +} + +/*returns 1 if success, 0 if failure ==> nothing done*/ +static unsigned uivector_resize(uivector* p, size_t size) { + if(!uivector_reserve(p, size * sizeof(unsigned))) return 0; + p->size = size; + return 1; /*success*/ +} + +/*resize and give all new elements the value*/ +static unsigned uivector_resizev(uivector* p, size_t size, unsigned value) { + size_t oldsize = p->size, i; + if(!uivector_resize(p, size)) return 0; + for(i = oldsize; i < size; ++i) p->data[i] = value; + return 1; +} + +static void uivector_init(uivector* p) { + p->data = NULL; + p->size = p->allocsize = 0; +} + +#ifdef LODEPNG_COMPILE_ENCODER +/*returns 1 if success, 0 if failure ==> nothing done*/ +static unsigned uivector_push_back(uivector* p, unsigned c) { + if(!uivector_resize(p, p->size + 1)) return 0; + p->data[p->size - 1] = c; + return 1; +} +#endif /*LODEPNG_COMPILE_ENCODER*/ +#endif /*LODEPNG_COMPILE_ZLIB*/ + +/* /////////////////////////////////////////////////////////////////////////// */ + +/*dynamic vector of unsigned chars*/ +typedef struct ucvector { + unsigned char* data; + size_t size; /*used size*/ + size_t allocsize; /*allocated size*/ +} ucvector; + +/*returns 1 if success, 0 if failure ==> nothing done*/ +static unsigned ucvector_reserve(ucvector* p, size_t allocsize) { + if(allocsize > p->allocsize) { + size_t newsize = (allocsize > p->allocsize * 2) ? allocsize : (allocsize * 3 / 2); + void* data = lodepng_realloc(p->data, newsize); + if(data) { + p->allocsize = newsize; + p->data = (unsigned char*)data; + } + else return 0; /*error: not enough memory*/ + } + return 1; +} + +/*returns 1 if success, 0 if failure ==> nothing done*/ +static unsigned ucvector_resize(ucvector* p, size_t size) { + if(!ucvector_reserve(p, size * sizeof(unsigned char))) return 0; + p->size = size; + return 1; /*success*/ +} + +#ifdef LODEPNG_COMPILE_PNG + +static void ucvector_cleanup(void* p) { + ((ucvector*)p)->size = ((ucvector*)p)->allocsize = 0; + lodepng_free(((ucvector*)p)->data); + ((ucvector*)p)->data = NULL; +} + +static void ucvector_init(ucvector* p) { + p->data = NULL; + p->size = p->allocsize = 0; +} +#endif /*LODEPNG_COMPILE_PNG*/ + +#ifdef LODEPNG_COMPILE_ZLIB +/*you can both convert from vector to buffer&size and vica versa. If you use +init_buffer to take over a buffer and size, it is not needed to use cleanup*/ +static void ucvector_init_buffer(ucvector* p, unsigned char* buffer, size_t size) { + p->data = buffer; + p->allocsize = p->size = size; +} +#endif /*LODEPNG_COMPILE_ZLIB*/ + +#if (defined(LODEPNG_COMPILE_PNG) && defined(LODEPNG_COMPILE_ANCILLARY_CHUNKS)) || defined(LODEPNG_COMPILE_ENCODER) +/*returns 1 if success, 0 if failure ==> nothing done*/ +static unsigned ucvector_push_back(ucvector* p, unsigned char c) { + if(!ucvector_resize(p, p->size + 1)) return 0; + p->data[p->size - 1] = c; + return 1; +} +#endif /*defined(LODEPNG_COMPILE_PNG) || defined(LODEPNG_COMPILE_ENCODER)*/ + + +/* ////////////////////////////////////////////////////////////////////////// */ + +#ifdef LODEPNG_COMPILE_PNG +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + +/*free string pointer and set it to NULL*/ +static void string_cleanup(char** out) { + lodepng_free(*out); + *out = NULL; +} + +/* dynamically allocates a new string with a copy of the null terminated input text */ +static char* alloc_string(const char* in) { + size_t insize = strlen(in); + char* out = (char*)lodepng_malloc(insize + 1); + if(out) { + size_t i; + for(i = 0; i != insize; ++i) { + out[i] = in[i]; + } + out[i] = 0; + } + return out; +} +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ +#endif /*LODEPNG_COMPILE_PNG*/ + +/* ////////////////////////////////////////////////////////////////////////// */ + +unsigned lodepng_read32bitInt(const unsigned char* buffer) { + return (unsigned)((buffer[0] << 24) | (buffer[1] << 16) | (buffer[2] << 8) | buffer[3]); +} + +#if defined(LODEPNG_COMPILE_PNG) || defined(LODEPNG_COMPILE_ENCODER) +/*buffer must have at least 4 allocated bytes available*/ +static void lodepng_set32bitInt(unsigned char* buffer, unsigned value) { + buffer[0] = (unsigned char)((value >> 24) & 0xff); + buffer[1] = (unsigned char)((value >> 16) & 0xff); + buffer[2] = (unsigned char)((value >> 8) & 0xff); + buffer[3] = (unsigned char)((value ) & 0xff); +} +#endif /*defined(LODEPNG_COMPILE_PNG) || defined(LODEPNG_COMPILE_ENCODER)*/ + +#ifdef LODEPNG_COMPILE_ENCODER +static void lodepng_add32bitInt(ucvector* buffer, unsigned value) { + ucvector_resize(buffer, buffer->size + 4); /*todo: give error if resize failed*/ + lodepng_set32bitInt(&buffer->data[buffer->size - 4], value); +} +#endif /*LODEPNG_COMPILE_ENCODER*/ + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / File IO / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +#ifdef LODEPNG_COMPILE_DISK + +/* returns negative value on error. This should be pure C compatible, so no fstat. */ +static long lodepng_filesize(const char* filename) { + FILE* file; + long size; + file = fopen(filename, "rb"); + if(!file) return -1; + + if(fseek(file, 0, SEEK_END) != 0) { + fclose(file); + return -1; + } + + size = ftell(file); + /* It may give LONG_MAX as directory size, this is invalid for us. */ + if(size == LONG_MAX) size = -1; + + fclose(file); + return size; +} + +/* load file into buffer that already has the correct allocated size. Returns error code.*/ +static unsigned lodepng_buffer_file(unsigned char* out, size_t size, const char* filename) { + FILE* file; + size_t readsize; + file = fopen(filename, "rb"); + if(!file) return 78; + + readsize = fread(out, 1, size, file); + fclose(file); + + if (readsize != size) return 78; + return 0; +} + +unsigned lodepng_load_file(unsigned char** out, size_t* outsize, const char* filename) { + long size = lodepng_filesize(filename); + if (size < 0) return 78; + *outsize = (size_t)size; + + *out = (unsigned char*)lodepng_malloc((size_t)size); + if(!(*out) && size > 0) return 83; /*the above malloc failed*/ + + return lodepng_buffer_file(*out, (size_t)size, filename); +} + +/*write given buffer to the file, overwriting the file, it doesn't append to it.*/ +unsigned lodepng_save_file(const unsigned char* buffer, size_t buffersize, const char* filename) { + FILE* file; + file = fopen(filename, "wb" ); + if(!file) return 79; + fwrite(buffer, 1, buffersize, file); + fclose(file); + return 0; +} + +#endif /*LODEPNG_COMPILE_DISK*/ + +/* ////////////////////////////////////////////////////////////////////////// */ +/* ////////////////////////////////////////////////////////////////////////// */ +/* // End of common code and tools. Begin of Zlib related code. // */ +/* ////////////////////////////////////////////////////////////////////////// */ +/* ////////////////////////////////////////////////////////////////////////// */ + +#ifdef LODEPNG_COMPILE_ZLIB +#ifdef LODEPNG_COMPILE_ENCODER +/*TODO: this ignores potential out of memory errors*/ +#define addBitToStream(/*size_t**/ bitpointer, /*ucvector**/ bitstream, /*unsigned char*/ bit){\ + /*add a new byte at the end*/\ + if(((*bitpointer) & 7) == 0) ucvector_push_back(bitstream, (unsigned char)0);\ + /*earlier bit of huffman code is in a lesser significant bit of an earlier byte*/\ + (bitstream->data[bitstream->size - 1]) |= (bit << ((*bitpointer) & 0x7));\ + ++(*bitpointer);\ +} + +static void addBitsToStream(size_t* bitpointer, ucvector* bitstream, unsigned value, size_t nbits) { + size_t i; + for(i = 0; i != nbits; ++i) addBitToStream(bitpointer, bitstream, (unsigned char)((value >> i) & 1)); +} + +static void addBitsToStreamReversed(size_t* bitpointer, ucvector* bitstream, unsigned value, size_t nbits) { + size_t i; + for(i = 0; i != nbits; ++i) addBitToStream(bitpointer, bitstream, (unsigned char)((value >> (nbits - 1 - i)) & 1)); +} +#endif /*LODEPNG_COMPILE_ENCODER*/ + +#ifdef LODEPNG_COMPILE_DECODER + +#define READBIT(bitpointer, bitstream) ((bitstream[bitpointer >> 3] >> (bitpointer & 0x7)) & (unsigned char)1) + +static unsigned char readBitFromStream(size_t* bitpointer, const unsigned char* bitstream) { + unsigned char result = (unsigned char)(READBIT(*bitpointer, bitstream)); + ++(*bitpointer); + return result; +} + +static unsigned readBitsFromStream(size_t* bitpointer, const unsigned char* bitstream, size_t nbits) { + unsigned result = 0, i; + for(i = 0; i != nbits; ++i) { + result += ((unsigned)READBIT(*bitpointer, bitstream)) << i; + ++(*bitpointer); + } + return result; +} +#endif /*LODEPNG_COMPILE_DECODER*/ + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / Deflate - Huffman / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +#define FIRST_LENGTH_CODE_INDEX 257 +#define LAST_LENGTH_CODE_INDEX 285 +/*256 literals, the end code, some length codes, and 2 unused codes*/ +#define NUM_DEFLATE_CODE_SYMBOLS 288 +/*the distance codes have their own symbols, 30 used, 2 unused*/ +#define NUM_DISTANCE_SYMBOLS 32 +/*the code length codes. 0-15: code lengths, 16: copy previous 3-6 times, 17: 3-10 zeros, 18: 11-138 zeros*/ +#define NUM_CODE_LENGTH_CODES 19 + +/*the base lengths represented by codes 257-285*/ +static const unsigned LENGTHBASE[29] + = {3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 19, 23, 27, 31, 35, 43, 51, 59, + 67, 83, 99, 115, 131, 163, 195, 227, 258}; + +/*the extra bits used by codes 257-285 (added to base length)*/ +static const unsigned LENGTHEXTRA[29] + = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, + 4, 4, 4, 4, 5, 5, 5, 5, 0}; + +/*the base backwards distances (the bits of distance codes appear after length codes and use their own huffman tree)*/ +static const unsigned DISTANCEBASE[30] + = {1, 2, 3, 4, 5, 7, 9, 13, 17, 25, 33, 49, 65, 97, 129, 193, 257, 385, 513, + 769, 1025, 1537, 2049, 3073, 4097, 6145, 8193, 12289, 16385, 24577}; + +/*the extra bits of backwards distances (added to base)*/ +static const unsigned DISTANCEEXTRA[30] + = {0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, + 8, 9, 9, 10, 10, 11, 11, 12, 12, 13, 13}; + +/*the order in which "code length alphabet code lengths" are stored, out of this +the huffman tree of the dynamic huffman tree lengths is generated*/ +static const unsigned CLCL_ORDER[NUM_CODE_LENGTH_CODES] + = {16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15}; + +/* ////////////////////////////////////////////////////////////////////////// */ + +/* +Huffman tree struct, containing multiple representations of the tree +*/ +typedef struct HuffmanTree { + unsigned* tree2d; + unsigned* tree1d; + unsigned* lengths; /*the lengths of the codes of the 1d-tree*/ + unsigned maxbitlen; /*maximum number of bits a single code can get*/ + unsigned numcodes; /*number of symbols in the alphabet = number of codes*/ +} HuffmanTree; + +/*function used for debug purposes to draw the tree in ascii art with C++*/ +/* +static void HuffmanTree_draw(HuffmanTree* tree) { + std::cout << "tree. length: " << tree->numcodes << " maxbitlen: " << tree->maxbitlen << std::endl; + for(size_t i = 0; i != tree->tree1d.size; ++i) { + if(tree->lengths.data[i]) + std::cout << i << " " << tree->tree1d.data[i] << " " << tree->lengths.data[i] << std::endl; + } + std::cout << std::endl; +}*/ + +static void HuffmanTree_init(HuffmanTree* tree) { + tree->tree2d = 0; + tree->tree1d = 0; + tree->lengths = 0; +} + +static void HuffmanTree_cleanup(HuffmanTree* tree) { + lodepng_free(tree->tree2d); + lodepng_free(tree->tree1d); + lodepng_free(tree->lengths); +} + +/*the tree representation used by the decoder. return value is error*/ +static unsigned HuffmanTree_make2DTree(HuffmanTree* tree) { + unsigned nodefilled = 0; /*up to which node it is filled*/ + unsigned treepos = 0; /*position in the tree (1 of the numcodes columns)*/ + unsigned n, i; + + tree->tree2d = (unsigned*)lodepng_malloc(tree->numcodes * 2 * sizeof(unsigned)); + if(!tree->tree2d) return 83; /*alloc fail*/ + + /* + convert tree1d[] to tree2d[][]. In the 2D array, a value of 32767 means + uninited, a value >= numcodes is an address to another bit, a value < numcodes + is a code. The 2 rows are the 2 possible bit values (0 or 1), there are as + many columns as codes - 1. + A good huffman tree has N * 2 - 1 nodes, of which N - 1 are internal nodes. + Here, the internal nodes are stored (what their 0 and 1 option point to). + There is only memory for such good tree currently, if there are more nodes + (due to too long length codes), error 55 will happen + */ + for(n = 0; n < tree->numcodes * 2; ++n) { + tree->tree2d[n] = 32767; /*32767 here means the tree2d isn't filled there yet*/ + } + + for(n = 0; n < tree->numcodes; ++n) /*the codes*/ { + for(i = 0; i != tree->lengths[n]; ++i) /*the bits for this code*/ { + unsigned char bit = (unsigned char)((tree->tree1d[n] >> (tree->lengths[n] - i - 1)) & 1); + /*oversubscribed, see comment in lodepng_error_text*/ + if(treepos > 2147483647 || treepos + 2 > tree->numcodes) return 55; + if(tree->tree2d[2 * treepos + bit] == 32767) /*not yet filled in*/ { + if(i + 1 == tree->lengths[n]) /*last bit*/ { + tree->tree2d[2 * treepos + bit] = n; /*put the current code in it*/ + treepos = 0; + } else { + /*put address of the next step in here, first that address has to be found of course + (it's just nodefilled + 1)...*/ + ++nodefilled; + /*addresses encoded with numcodes added to it*/ + tree->tree2d[2 * treepos + bit] = nodefilled + tree->numcodes; + treepos = nodefilled; + } + } + else treepos = tree->tree2d[2 * treepos + bit] - tree->numcodes; + } + } + + for(n = 0; n < tree->numcodes * 2; ++n) { + if(tree->tree2d[n] == 32767) tree->tree2d[n] = 0; /*remove possible remaining 32767's*/ + } + + return 0; +} + +/* +Second step for the ...makeFromLengths and ...makeFromFrequencies functions. +numcodes, lengths and maxbitlen must already be filled in correctly. return +value is error. +*/ +static unsigned HuffmanTree_makeFromLengths2(HuffmanTree* tree) { + uivector blcount; + uivector nextcode; + unsigned error = 0; + unsigned bits, n; + + uivector_init(&blcount); + uivector_init(&nextcode); + + tree->tree1d = (unsigned*)lodepng_malloc(tree->numcodes * sizeof(unsigned)); + if(!tree->tree1d) error = 83; /*alloc fail*/ + + if(!uivector_resizev(&blcount, tree->maxbitlen + 1, 0) + || !uivector_resizev(&nextcode, tree->maxbitlen + 1, 0)) + error = 83; /*alloc fail*/ + + if(!error) { + /*step 1: count number of instances of each code length*/ + for(bits = 0; bits != tree->numcodes; ++bits) ++blcount.data[tree->lengths[bits]]; + /*step 2: generate the nextcode values*/ + for(bits = 1; bits <= tree->maxbitlen; ++bits) { + nextcode.data[bits] = (nextcode.data[bits - 1] + blcount.data[bits - 1]) << 1; + } + /*step 3: generate all the codes*/ + for(n = 0; n != tree->numcodes; ++n) { + if(tree->lengths[n] != 0) tree->tree1d[n] = nextcode.data[tree->lengths[n]]++; + } + } + + uivector_cleanup(&blcount); + uivector_cleanup(&nextcode); + + if(!error) return HuffmanTree_make2DTree(tree); + else return error; +} + +/* +given the code lengths (as stored in the PNG file), generate the tree as defined +by Deflate. maxbitlen is the maximum bits that a code in the tree can have. +return value is error. +*/ +static unsigned HuffmanTree_makeFromLengths(HuffmanTree* tree, const unsigned* bitlen, + size_t numcodes, unsigned maxbitlen) { + unsigned i; + tree->lengths = (unsigned*)lodepng_malloc(numcodes * sizeof(unsigned)); + if(!tree->lengths) return 83; /*alloc fail*/ + for(i = 0; i != numcodes; ++i) tree->lengths[i] = bitlen[i]; + tree->numcodes = (unsigned)numcodes; /*number of symbols*/ + tree->maxbitlen = maxbitlen; + return HuffmanTree_makeFromLengths2(tree); +} + +#ifdef LODEPNG_COMPILE_ENCODER + +/*BPM: Boundary Package Merge, see "A Fast and Space-Economical Algorithm for Length-Limited Coding", +Jyrki Katajainen, Alistair Moffat, Andrew Turpin, 1995.*/ + +/*chain node for boundary package merge*/ +typedef struct BPMNode { + int weight; /*the sum of all weights in this chain*/ + unsigned index; /*index of this leaf node (called "count" in the paper)*/ + struct BPMNode* tail; /*the next nodes in this chain (null if last)*/ + int in_use; +} BPMNode; + +/*lists of chains*/ +typedef struct BPMLists { + /*memory pool*/ + unsigned memsize; + BPMNode* memory; + unsigned numfree; + unsigned nextfree; + BPMNode** freelist; + /*two heads of lookahead chains per list*/ + unsigned listsize; + BPMNode** chains0; + BPMNode** chains1; +} BPMLists; + +/*creates a new chain node with the given parameters, from the memory in the lists */ +static BPMNode* bpmnode_create(BPMLists* lists, int weight, unsigned index, BPMNode* tail) { + unsigned i; + BPMNode* result; + + /*memory full, so garbage collect*/ + if(lists->nextfree >= lists->numfree) { + /*mark only those that are in use*/ + for(i = 0; i != lists->memsize; ++i) lists->memory[i].in_use = 0; + for(i = 0; i != lists->listsize; ++i) { + BPMNode* node; + for(node = lists->chains0[i]; node != 0; node = node->tail) node->in_use = 1; + for(node = lists->chains1[i]; node != 0; node = node->tail) node->in_use = 1; + } + /*collect those that are free*/ + lists->numfree = 0; + for(i = 0; i != lists->memsize; ++i) { + if(!lists->memory[i].in_use) lists->freelist[lists->numfree++] = &lists->memory[i]; + } + lists->nextfree = 0; + } + + result = lists->freelist[lists->nextfree++]; + result->weight = weight; + result->index = index; + result->tail = tail; + return result; +} + +/*sort the leaves with stable mergesort*/ +static void bpmnode_sort(BPMNode* leaves, size_t num) { + BPMNode* mem = (BPMNode*)lodepng_malloc(sizeof(*leaves) * num); + size_t width, counter = 0; + for(width = 1; width < num; width *= 2) { + BPMNode* a = (counter & 1) ? mem : leaves; + BPMNode* b = (counter & 1) ? leaves : mem; + size_t p; + for(p = 0; p < num; p += 2 * width) { + size_t q = (p + width > num) ? num : (p + width); + size_t r = (p + 2 * width > num) ? num : (p + 2 * width); + size_t i = p, j = q, k; + for(k = p; k < r; k++) { + if(i < q && (j >= r || a[i].weight <= a[j].weight)) b[k] = a[i++]; + else b[k] = a[j++]; + } + } + counter++; + } + if(counter & 1) memcpy(leaves, mem, sizeof(*leaves) * num); + lodepng_free(mem); +} + +/*Boundary Package Merge step, numpresent is the amount of leaves, and c is the current chain.*/ +static void boundaryPM(BPMLists* lists, BPMNode* leaves, size_t numpresent, int c, int num) { + unsigned lastindex = lists->chains1[c]->index; + + if(c == 0) { + if(lastindex >= numpresent) return; + lists->chains0[c] = lists->chains1[c]; + lists->chains1[c] = bpmnode_create(lists, leaves[lastindex].weight, lastindex + 1, 0); + } else { + /*sum of the weights of the head nodes of the previous lookahead chains.*/ + int sum = lists->chains0[c - 1]->weight + lists->chains1[c - 1]->weight; + lists->chains0[c] = lists->chains1[c]; + if(lastindex < numpresent && sum > leaves[lastindex].weight) { + lists->chains1[c] = bpmnode_create(lists, leaves[lastindex].weight, lastindex + 1, lists->chains1[c]->tail); + return; + } + lists->chains1[c] = bpmnode_create(lists, sum, lastindex, lists->chains1[c - 1]); + /*in the end we are only interested in the chain of the last list, so no + need to recurse if we're at the last one (this gives measurable speedup)*/ + if(num + 1 < (int)(2 * numpresent - 2)) { + boundaryPM(lists, leaves, numpresent, c - 1, num); + boundaryPM(lists, leaves, numpresent, c - 1, num); + } + } +} + +unsigned lodepng_huffman_code_lengths(unsigned* lengths, const unsigned* frequencies, + size_t numcodes, unsigned maxbitlen) { + unsigned error = 0; + unsigned i; + size_t numpresent = 0; /*number of symbols with non-zero frequency*/ + BPMNode* leaves; /*the symbols, only those with > 0 frequency*/ + + if(numcodes == 0) return 80; /*error: a tree of 0 symbols is not supposed to be made*/ + if((1u << maxbitlen) < (unsigned)numcodes) return 80; /*error: represent all symbols*/ + + leaves = (BPMNode*)lodepng_malloc(numcodes * sizeof(*leaves)); + if(!leaves) return 83; /*alloc fail*/ + + for(i = 0; i != numcodes; ++i) { + if(frequencies[i] > 0) { + leaves[numpresent].weight = (int)frequencies[i]; + leaves[numpresent].index = i; + ++numpresent; + } + } + + for(i = 0; i != numcodes; ++i) lengths[i] = 0; + + /*ensure at least two present symbols. There should be at least one symbol + according to RFC 1951 section 3.2.7. Some decoders incorrectly require two. To + make these work as well ensure there are at least two symbols. The + Package-Merge code below also doesn't work correctly if there's only one + symbol, it'd give it the theoritical 0 bits but in practice zlib wants 1 bit*/ + if(numpresent == 0) { + lengths[0] = lengths[1] = 1; /*note that for RFC 1951 section 3.2.7, only lengths[0] = 1 is needed*/ + } else if(numpresent == 1) { + lengths[leaves[0].index] = 1; + lengths[leaves[0].index == 0 ? 1 : 0] = 1; + } else { + BPMLists lists; + BPMNode* node; + + bpmnode_sort(leaves, numpresent); + + lists.listsize = maxbitlen; + lists.memsize = 2 * maxbitlen * (maxbitlen + 1); + lists.nextfree = 0; + lists.numfree = lists.memsize; + lists.memory = (BPMNode*)lodepng_malloc(lists.memsize * sizeof(*lists.memory)); + lists.freelist = (BPMNode**)lodepng_malloc(lists.memsize * sizeof(BPMNode*)); + lists.chains0 = (BPMNode**)lodepng_malloc(lists.listsize * sizeof(BPMNode*)); + lists.chains1 = (BPMNode**)lodepng_malloc(lists.listsize * sizeof(BPMNode*)); + if(!lists.memory || !lists.freelist || !lists.chains0 || !lists.chains1) error = 83; /*alloc fail*/ + + if(!error) { + for(i = 0; i != lists.memsize; ++i) lists.freelist[i] = &lists.memory[i]; + + bpmnode_create(&lists, leaves[0].weight, 1, 0); + bpmnode_create(&lists, leaves[1].weight, 2, 0); + + for(i = 0; i != lists.listsize; ++i) { + lists.chains0[i] = &lists.memory[0]; + lists.chains1[i] = &lists.memory[1]; + } + + /*each boundaryPM call adds one chain to the last list, and we need 2 * numpresent - 2 chains.*/ + for(i = 2; i != 2 * numpresent - 2; ++i) boundaryPM(&lists, leaves, numpresent, (int)maxbitlen - 1, (int)i); + + for(node = lists.chains1[maxbitlen - 1]; node; node = node->tail) { + for(i = 0; i != node->index; ++i) ++lengths[leaves[i].index]; + } + } + + lodepng_free(lists.memory); + lodepng_free(lists.freelist); + lodepng_free(lists.chains0); + lodepng_free(lists.chains1); + } + + lodepng_free(leaves); + return error; +} + +/*Create the Huffman tree given the symbol frequencies*/ +static unsigned HuffmanTree_makeFromFrequencies(HuffmanTree* tree, const unsigned* frequencies, + size_t mincodes, size_t numcodes, unsigned maxbitlen) { + unsigned error = 0; + while(!frequencies[numcodes - 1] && numcodes > mincodes) --numcodes; /*trim zeroes*/ + tree->maxbitlen = maxbitlen; + tree->numcodes = (unsigned)numcodes; /*number of symbols*/ + tree->lengths = (unsigned*)lodepng_realloc(tree->lengths, numcodes * sizeof(unsigned)); + if(!tree->lengths) return 83; /*alloc fail*/ + /*initialize all lengths to 0*/ + memset(tree->lengths, 0, numcodes * sizeof(unsigned)); + + error = lodepng_huffman_code_lengths(tree->lengths, frequencies, numcodes, maxbitlen); + if(!error) error = HuffmanTree_makeFromLengths2(tree); + return error; +} + +static unsigned HuffmanTree_getCode(const HuffmanTree* tree, unsigned index) { + return tree->tree1d[index]; +} + +static unsigned HuffmanTree_getLength(const HuffmanTree* tree, unsigned index) { + return tree->lengths[index]; +} +#endif /*LODEPNG_COMPILE_ENCODER*/ + +/*get the literal and length code tree of a deflated block with fixed tree, as per the deflate specification*/ +static unsigned generateFixedLitLenTree(HuffmanTree* tree) { + unsigned i, error = 0; + unsigned* bitlen = (unsigned*)lodepng_malloc(NUM_DEFLATE_CODE_SYMBOLS * sizeof(unsigned)); + if(!bitlen) return 83; /*alloc fail*/ + + /*288 possible codes: 0-255=literals, 256=endcode, 257-285=lengthcodes, 286-287=unused*/ + for(i = 0; i <= 143; ++i) bitlen[i] = 8; + for(i = 144; i <= 255; ++i) bitlen[i] = 9; + for(i = 256; i <= 279; ++i) bitlen[i] = 7; + for(i = 280; i <= 287; ++i) bitlen[i] = 8; + + error = HuffmanTree_makeFromLengths(tree, bitlen, NUM_DEFLATE_CODE_SYMBOLS, 15); + + lodepng_free(bitlen); + return error; +} + +/*get the distance code tree of a deflated block with fixed tree, as specified in the deflate specification*/ +static unsigned generateFixedDistanceTree(HuffmanTree* tree) { + unsigned i, error = 0; + unsigned* bitlen = (unsigned*)lodepng_malloc(NUM_DISTANCE_SYMBOLS * sizeof(unsigned)); + if(!bitlen) return 83; /*alloc fail*/ + + /*there are 32 distance codes, but 30-31 are unused*/ + for(i = 0; i != NUM_DISTANCE_SYMBOLS; ++i) bitlen[i] = 5; + error = HuffmanTree_makeFromLengths(tree, bitlen, NUM_DISTANCE_SYMBOLS, 15); + + lodepng_free(bitlen); + return error; +} + +#ifdef LODEPNG_COMPILE_DECODER + +/* +returns the code, or (unsigned)(-1) if error happened +inbitlength is the length of the complete buffer, in bits (so its byte length times 8) +*/ +static unsigned huffmanDecodeSymbol(const unsigned char* in, size_t* bp, + const HuffmanTree* codetree, size_t inbitlength) { + unsigned treepos = 0, ct; + for(;;) { + if(*bp >= inbitlength) return (unsigned)(-1); /*error: end of input memory reached without endcode*/ + /* + decode the symbol from the tree. The "readBitFromStream" code is inlined in + the expression below because this is the biggest bottleneck while decoding + */ + ct = codetree->tree2d[(treepos << 1) + READBIT(*bp, in)]; + ++(*bp); + if(ct < codetree->numcodes) return ct; /*the symbol is decoded, return it*/ + else treepos = ct - codetree->numcodes; /*symbol not yet decoded, instead move tree position*/ + + if(treepos >= codetree->numcodes) return (unsigned)(-1); /*error: it appeared outside the codetree*/ + } +} +#endif /*LODEPNG_COMPILE_DECODER*/ + +#ifdef LODEPNG_COMPILE_DECODER + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / Inflator (Decompressor) / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +/*get the tree of a deflated block with fixed tree, as specified in the deflate specification*/ +static void getTreeInflateFixed(HuffmanTree* tree_ll, HuffmanTree* tree_d) { + /*TODO: check for out of memory errors*/ + generateFixedLitLenTree(tree_ll); + generateFixedDistanceTree(tree_d); +} + +/*get the tree of a deflated block with dynamic tree, the tree itself is also Huffman compressed with a known tree*/ +static unsigned getTreeInflateDynamic(HuffmanTree* tree_ll, HuffmanTree* tree_d, + const unsigned char* in, size_t* bp, size_t inlength) { + /*make sure that length values that aren't filled in will be 0, or a wrong tree will be generated*/ + unsigned error = 0; + unsigned n, HLIT, HDIST, HCLEN, i; + size_t inbitlength = inlength * 8; + + /*see comments in deflateDynamic for explanation of the context and these variables, it is analogous*/ + unsigned* bitlen_ll = 0; /*lit,len code lengths*/ + unsigned* bitlen_d = 0; /*dist code lengths*/ + /*code length code lengths ("clcl"), the bit lengths of the huffman tree used to compress bitlen_ll and bitlen_d*/ + unsigned* bitlen_cl = 0; + HuffmanTree tree_cl; /*the code tree for code length codes (the huffman tree for compressed huffman trees)*/ + + if((*bp) + 14 > (inlength << 3)) return 49; /*error: the bit pointer is or will go past the memory*/ + + /*number of literal/length codes + 257. Unlike the spec, the value 257 is added to it here already*/ + HLIT = readBitsFromStream(bp, in, 5) + 257; + /*number of distance codes. Unlike the spec, the value 1 is added to it here already*/ + HDIST = readBitsFromStream(bp, in, 5) + 1; + /*number of code length codes. Unlike the spec, the value 4 is added to it here already*/ + HCLEN = readBitsFromStream(bp, in, 4) + 4; + + if((*bp) + HCLEN * 3 > (inlength << 3)) return 50; /*error: the bit pointer is or will go past the memory*/ + + HuffmanTree_init(&tree_cl); + + while(!error) { + /*read the code length codes out of 3 * (amount of code length codes) bits*/ + + bitlen_cl = (unsigned*)lodepng_malloc(NUM_CODE_LENGTH_CODES * sizeof(unsigned)); + if(!bitlen_cl) ERROR_BREAK(83 /*alloc fail*/); + + for(i = 0; i != NUM_CODE_LENGTH_CODES; ++i) { + if(i < HCLEN) bitlen_cl[CLCL_ORDER[i]] = readBitsFromStream(bp, in, 3); + else bitlen_cl[CLCL_ORDER[i]] = 0; /*if not, it must stay 0*/ + } + + error = HuffmanTree_makeFromLengths(&tree_cl, bitlen_cl, NUM_CODE_LENGTH_CODES, 7); + if(error) break; + + /*now we can use this tree to read the lengths for the tree that this function will return*/ + bitlen_ll = (unsigned*)lodepng_malloc(NUM_DEFLATE_CODE_SYMBOLS * sizeof(unsigned)); + bitlen_d = (unsigned*)lodepng_malloc(NUM_DISTANCE_SYMBOLS * sizeof(unsigned)); + if(!bitlen_ll || !bitlen_d) ERROR_BREAK(83 /*alloc fail*/); + for(i = 0; i != NUM_DEFLATE_CODE_SYMBOLS; ++i) bitlen_ll[i] = 0; + for(i = 0; i != NUM_DISTANCE_SYMBOLS; ++i) bitlen_d[i] = 0; + + /*i is the current symbol we're reading in the part that contains the code lengths of lit/len and dist codes*/ + i = 0; + while(i < HLIT + HDIST) { + unsigned code = huffmanDecodeSymbol(in, bp, &tree_cl, inbitlength); + if(code <= 15) /*a length code*/ { + if(i < HLIT) bitlen_ll[i] = code; + else bitlen_d[i - HLIT] = code; + ++i; + } else if(code == 16) /*repeat previous*/ { + unsigned replength = 3; /*read in the 2 bits that indicate repeat length (3-6)*/ + unsigned value; /*set value to the previous code*/ + + if(i == 0) ERROR_BREAK(54); /*can't repeat previous if i is 0*/ + + if((*bp + 2) > inbitlength) ERROR_BREAK(50); /*error, bit pointer jumps past memory*/ + replength += readBitsFromStream(bp, in, 2); + + if(i < HLIT + 1) value = bitlen_ll[i - 1]; + else value = bitlen_d[i - HLIT - 1]; + /*repeat this value in the next lengths*/ + for(n = 0; n < replength; ++n) { + if(i >= HLIT + HDIST) ERROR_BREAK(13); /*error: i is larger than the amount of codes*/ + if(i < HLIT) bitlen_ll[i] = value; + else bitlen_d[i - HLIT] = value; + ++i; + } + } else if(code == 17) /*repeat "0" 3-10 times*/ { + unsigned replength = 3; /*read in the bits that indicate repeat length*/ + if((*bp + 3) > inbitlength) ERROR_BREAK(50); /*error, bit pointer jumps past memory*/ + replength += readBitsFromStream(bp, in, 3); + + /*repeat this value in the next lengths*/ + for(n = 0; n < replength; ++n) { + if(i >= HLIT + HDIST) ERROR_BREAK(14); /*error: i is larger than the amount of codes*/ + + if(i < HLIT) bitlen_ll[i] = 0; + else bitlen_d[i - HLIT] = 0; + ++i; + } + } else if(code == 18) /*repeat "0" 11-138 times*/ { + unsigned replength = 11; /*read in the bits that indicate repeat length*/ + if((*bp + 7) > inbitlength) ERROR_BREAK(50); /*error, bit pointer jumps past memory*/ + replength += readBitsFromStream(bp, in, 7); + + /*repeat this value in the next lengths*/ + for(n = 0; n < replength; ++n) { + if(i >= HLIT + HDIST) ERROR_BREAK(15); /*error: i is larger than the amount of codes*/ + + if(i < HLIT) bitlen_ll[i] = 0; + else bitlen_d[i - HLIT] = 0; + ++i; + } + } else /*if(code == (unsigned)(-1))*/ /*huffmanDecodeSymbol returns (unsigned)(-1) in case of error*/ { + if(code == (unsigned)(-1)) { + /*return error code 10 or 11 depending on the situation that happened in huffmanDecodeSymbol + (10=no endcode, 11=wrong jump outside of tree)*/ + error = (*bp) > inbitlength ? 10 : 11; + } + else error = 16; /*unexisting code, this can never happen*/ + break; + } + } + if(error) break; + + if(bitlen_ll[256] == 0) ERROR_BREAK(64); /*the length of the end code 256 must be larger than 0*/ + + /*now we've finally got HLIT and HDIST, so generate the code trees, and the function is done*/ + error = HuffmanTree_makeFromLengths(tree_ll, bitlen_ll, NUM_DEFLATE_CODE_SYMBOLS, 15); + if(error) break; + error = HuffmanTree_makeFromLengths(tree_d, bitlen_d, NUM_DISTANCE_SYMBOLS, 15); + + break; /*end of error-while*/ + } + + lodepng_free(bitlen_cl); + lodepng_free(bitlen_ll); + lodepng_free(bitlen_d); + HuffmanTree_cleanup(&tree_cl); + + return error; +} + +/*inflate a block with dynamic of fixed Huffman tree*/ +static unsigned inflateHuffmanBlock(ucvector* out, const unsigned char* in, size_t* bp, + size_t* pos, size_t inlength, unsigned btype) { + unsigned error = 0; + HuffmanTree tree_ll; /*the huffman tree for literal and length codes*/ + HuffmanTree tree_d; /*the huffman tree for distance codes*/ + size_t inbitlength = inlength * 8; + + HuffmanTree_init(&tree_ll); + HuffmanTree_init(&tree_d); + + if(btype == 1) getTreeInflateFixed(&tree_ll, &tree_d); + else if(btype == 2) error = getTreeInflateDynamic(&tree_ll, &tree_d, in, bp, inlength); + + while(!error) /*decode all symbols until end reached, breaks at end code*/ { + /*code_ll is literal, length or end code*/ + unsigned code_ll = huffmanDecodeSymbol(in, bp, &tree_ll, inbitlength); + if(code_ll <= 255) /*literal symbol*/ { + /*ucvector_push_back would do the same, but for some reason the two lines below run 10% faster*/ + if(!ucvector_resize(out, (*pos) + 1)) ERROR_BREAK(83 /*alloc fail*/); + out->data[*pos] = (unsigned char)code_ll; + ++(*pos); + } else if(code_ll >= FIRST_LENGTH_CODE_INDEX && code_ll <= LAST_LENGTH_CODE_INDEX) /*length code*/ { + unsigned code_d, distance; + unsigned numextrabits_l, numextrabits_d; /*extra bits for length and distance*/ + size_t start, forward, backward, length; + + /*part 1: get length base*/ + length = LENGTHBASE[code_ll - FIRST_LENGTH_CODE_INDEX]; + + /*part 2: get extra bits and add the value of that to length*/ + numextrabits_l = LENGTHEXTRA[code_ll - FIRST_LENGTH_CODE_INDEX]; + if((*bp + numextrabits_l) > inbitlength) ERROR_BREAK(51); /*error, bit pointer will jump past memory*/ + length += readBitsFromStream(bp, in, numextrabits_l); + + /*part 3: get distance code*/ + code_d = huffmanDecodeSymbol(in, bp, &tree_d, inbitlength); + if(code_d > 29) { + if(code_d == (unsigned)(-1)) /*huffmanDecodeSymbol returns (unsigned)(-1) in case of error*/ { + /*return error code 10 or 11 depending on the situation that happened in huffmanDecodeSymbol + (10=no endcode, 11=wrong jump outside of tree)*/ + error = (*bp) > inlength * 8 ? 10 : 11; + } + else error = 18; /*error: invalid distance code (30-31 are never used)*/ + break; + } + distance = DISTANCEBASE[code_d]; + + /*part 4: get extra bits from distance*/ + numextrabits_d = DISTANCEEXTRA[code_d]; + if((*bp + numextrabits_d) > inbitlength) ERROR_BREAK(51); /*error, bit pointer will jump past memory*/ + distance += readBitsFromStream(bp, in, numextrabits_d); + + /*part 5: fill in all the out[n] values based on the length and dist*/ + start = (*pos); + if(distance > start) ERROR_BREAK(52); /*too long backward distance*/ + backward = start - distance; + + if(!ucvector_resize(out, (*pos) + length)) ERROR_BREAK(83 /*alloc fail*/); + if (distance < length) { + for(forward = 0; forward < length; ++forward) { + out->data[(*pos)++] = out->data[backward++]; + } + } else { + memcpy(out->data + *pos, out->data + backward, length); + *pos += length; + } + } else if(code_ll == 256) { + break; /*end code, break the loop*/ + } else /*if(code == (unsigned)(-1))*/ /*huffmanDecodeSymbol returns (unsigned)(-1) in case of error*/ { + /*return error code 10 or 11 depending on the situation that happened in huffmanDecodeSymbol + (10=no endcode, 11=wrong jump outside of tree)*/ + error = ((*bp) > inlength * 8) ? 10 : 11; + break; + } + } + + HuffmanTree_cleanup(&tree_ll); + HuffmanTree_cleanup(&tree_d); + + return error; +} + +static unsigned inflateNoCompression(ucvector* out, const unsigned char* in, size_t* bp, size_t* pos, size_t inlength) { + size_t p; + unsigned LEN, NLEN, n, error = 0; + + /*go to first boundary of byte*/ + while(((*bp) & 0x7) != 0) ++(*bp); + p = (*bp) / 8; /*byte position*/ + + /*read LEN (2 bytes) and NLEN (2 bytes)*/ + if(p + 4 >= inlength) return 52; /*error, bit pointer will jump past memory*/ + LEN = in[p] + 256u * in[p + 1]; p += 2; + NLEN = in[p] + 256u * in[p + 1]; p += 2; + + /*check if 16-bit NLEN is really the one's complement of LEN*/ + if(LEN + NLEN != 65535) return 21; /*error: NLEN is not one's complement of LEN*/ + + if(!ucvector_resize(out, (*pos) + LEN)) return 83; /*alloc fail*/ + + /*read the literal data: LEN bytes are now stored in the out buffer*/ + if(p + LEN > inlength) return 23; /*error: reading outside of in buffer*/ + for(n = 0; n < LEN; ++n) out->data[(*pos)++] = in[p++]; + + (*bp) = p * 8; + + return error; +} + +static unsigned lodepng_inflatev(ucvector* out, + const unsigned char* in, size_t insize, + const LodePNGDecompressSettings* settings) { + /*bit pointer in the "in" data, current byte is bp >> 3, current bit is bp & 0x7 (from lsb to msb of the byte)*/ + size_t bp = 0; + unsigned BFINAL = 0; + size_t pos = 0; /*byte position in the out buffer*/ + unsigned error = 0; + + (void)settings; + + while(!BFINAL) { + unsigned BTYPE; + if(bp + 2 >= insize * 8) return 52; /*error, bit pointer will jump past memory*/ + BFINAL = readBitFromStream(&bp, in); + BTYPE = 1u * readBitFromStream(&bp, in); + BTYPE += 2u * readBitFromStream(&bp, in); + + if(BTYPE == 3) return 20; /*error: invalid BTYPE*/ + else if(BTYPE == 0) error = inflateNoCompression(out, in, &bp, &pos, insize); /*no compression*/ + else error = inflateHuffmanBlock(out, in, &bp, &pos, insize, BTYPE); /*compression, BTYPE 01 or 10*/ + + if(error) return error; + } + + return error; +} + +unsigned lodepng_inflate(unsigned char** out, size_t* outsize, + const unsigned char* in, size_t insize, + const LodePNGDecompressSettings* settings) { + unsigned error; + ucvector v; + ucvector_init_buffer(&v, *out, *outsize); + error = lodepng_inflatev(&v, in, insize, settings); + *out = v.data; + *outsize = v.size; + return error; +} + +static unsigned inflate(unsigned char** out, size_t* outsize, + const unsigned char* in, size_t insize, + const LodePNGDecompressSettings* settings) { + if(settings->custom_inflate) { + return settings->custom_inflate(out, outsize, in, insize, settings); + } else { + return lodepng_inflate(out, outsize, in, insize, settings); + } +} + +#endif /*LODEPNG_COMPILE_DECODER*/ + +#ifdef LODEPNG_COMPILE_ENCODER + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / Deflator (Compressor) / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +static const size_t MAX_SUPPORTED_DEFLATE_LENGTH = 258; + +/*bitlen is the size in bits of the code*/ +static void addHuffmanSymbol(size_t* bp, ucvector* compressed, unsigned code, unsigned bitlen) { + addBitsToStreamReversed(bp, compressed, code, bitlen); +} + +/*search the index in the array, that has the largest value smaller than or equal to the given value, +given array must be sorted (if no value is smaller, it returns the size of the given array)*/ +static size_t searchCodeIndex(const unsigned* array, size_t array_size, size_t value) { + /*binary search (only small gain over linear). TODO: use CPU log2 instruction for getting symbols instead*/ + size_t left = 1; + size_t right = array_size - 1; + + while(left <= right) { + size_t mid = (left + right) >> 1; + if (array[mid] >= value) right = mid - 1; + else left = mid + 1; + } + if(left >= array_size || array[left] > value) left--; + return left; +} + +static void addLengthDistance(uivector* values, size_t length, size_t distance) { + /*values in encoded vector are those used by deflate: + 0-255: literal bytes + 256: end + 257-285: length/distance pair (length code, followed by extra length bits, distance code, extra distance bits) + 286-287: invalid*/ + + unsigned length_code = (unsigned)searchCodeIndex(LENGTHBASE, 29, length); + unsigned extra_length = (unsigned)(length - LENGTHBASE[length_code]); + unsigned dist_code = (unsigned)searchCodeIndex(DISTANCEBASE, 30, distance); + unsigned extra_distance = (unsigned)(distance - DISTANCEBASE[dist_code]); + + uivector_push_back(values, length_code + FIRST_LENGTH_CODE_INDEX); + uivector_push_back(values, extra_length); + uivector_push_back(values, dist_code); + uivector_push_back(values, extra_distance); +} + +/*3 bytes of data get encoded into two bytes. The hash cannot use more than 3 +bytes as input because 3 is the minimum match length for deflate*/ +static const unsigned HASH_NUM_VALUES = 65536; +static const unsigned HASH_BIT_MASK = 65535; /*HASH_NUM_VALUES - 1, but C90 does not like that as initializer*/ + +typedef struct Hash { + int* head; /*hash value to head circular pos - can be outdated if went around window*/ + /*circular pos to prev circular pos*/ + unsigned short* chain; + int* val; /*circular pos to hash value*/ + + /*TODO: do this not only for zeros but for any repeated byte. However for PNG + it's always going to be the zeros that dominate, so not important for PNG*/ + int* headz; /*similar to head, but for chainz*/ + unsigned short* chainz; /*those with same amount of zeros*/ + unsigned short* zeros; /*length of zeros streak, used as a second hash chain*/ +} Hash; + +static unsigned hash_init(Hash* hash, unsigned windowsize) { + unsigned i; + hash->head = (int*)lodepng_malloc(sizeof(int) * HASH_NUM_VALUES); + hash->val = (int*)lodepng_malloc(sizeof(int) * windowsize); + hash->chain = (unsigned short*)lodepng_malloc(sizeof(unsigned short) * windowsize); + + hash->zeros = (unsigned short*)lodepng_malloc(sizeof(unsigned short) * windowsize); + hash->headz = (int*)lodepng_malloc(sizeof(int) * (MAX_SUPPORTED_DEFLATE_LENGTH + 1)); + hash->chainz = (unsigned short*)lodepng_malloc(sizeof(unsigned short) * windowsize); + + if(!hash->head || !hash->chain || !hash->val || !hash->headz|| !hash->chainz || !hash->zeros) { + return 83; /*alloc fail*/ + } + + /*initialize hash table*/ + for(i = 0; i != HASH_NUM_VALUES; ++i) hash->head[i] = -1; + for(i = 0; i != windowsize; ++i) hash->val[i] = -1; + for(i = 0; i != windowsize; ++i) hash->chain[i] = i; /*same value as index indicates uninitialized*/ + + for(i = 0; i <= MAX_SUPPORTED_DEFLATE_LENGTH; ++i) hash->headz[i] = -1; + for(i = 0; i != windowsize; ++i) hash->chainz[i] = i; /*same value as index indicates uninitialized*/ + + return 0; +} + +static void hash_cleanup(Hash* hash) { + lodepng_free(hash->head); + lodepng_free(hash->val); + lodepng_free(hash->chain); + + lodepng_free(hash->zeros); + lodepng_free(hash->headz); + lodepng_free(hash->chainz); +} + + + +static unsigned getHash(const unsigned char* data, size_t size, size_t pos) { + unsigned result = 0; + if(pos + 2 < size) { + /*A simple shift and xor hash is used. Since the data of PNGs is dominated + by zeroes due to the filters, a better hash does not have a significant + effect on speed in traversing the chain, and causes more time spend on + calculating the hash.*/ + result ^= (unsigned)(data[pos + 0] << 0u); + result ^= (unsigned)(data[pos + 1] << 4u); + result ^= (unsigned)(data[pos + 2] << 8u); + } else { + size_t amount, i; + if(pos >= size) return 0; + amount = size - pos; + for(i = 0; i != amount; ++i) result ^= (unsigned)(data[pos + i] << (i * 8u)); + } + return result & HASH_BIT_MASK; +} + +static unsigned countZeros(const unsigned char* data, size_t size, size_t pos) { + const unsigned char* start = data + pos; + const unsigned char* end = start + MAX_SUPPORTED_DEFLATE_LENGTH; + if(end > data + size) end = data + size; + data = start; + while(data != end && *data == 0) ++data; + /*subtracting two addresses returned as 32-bit number (max value is MAX_SUPPORTED_DEFLATE_LENGTH)*/ + return (unsigned)(data - start); +} + +/*wpos = pos & (windowsize - 1)*/ +static void updateHashChain(Hash* hash, size_t wpos, unsigned hashval, unsigned short numzeros) { + hash->val[wpos] = (int)hashval; + if(hash->head[hashval] != -1) hash->chain[wpos] = hash->head[hashval]; + hash->head[hashval] = (int)wpos; + + hash->zeros[wpos] = numzeros; + if(hash->headz[numzeros] != -1) hash->chainz[wpos] = hash->headz[numzeros]; + hash->headz[numzeros] = (int)wpos; +} + +/* +LZ77-encode the data. Return value is error code. The input are raw bytes, the output +is in the form of unsigned integers with codes representing for example literal bytes, or +length/distance pairs. +It uses a hash table technique to let it encode faster. When doing LZ77 encoding, a +sliding window (of windowsize) is used, and all past bytes in that window can be used as +the "dictionary". A brute force search through all possible distances would be slow, and +this hash technique is one out of several ways to speed this up. +*/ +static unsigned encodeLZ77(uivector* out, Hash* hash, + const unsigned char* in, size_t inpos, size_t insize, unsigned windowsize, + unsigned minmatch, unsigned nicematch, unsigned lazymatching) { + size_t pos; + unsigned i, error = 0; + /*for large window lengths, assume the user wants no compression loss. Otherwise, max hash chain length speedup.*/ + unsigned maxchainlength = windowsize >= 8192 ? windowsize : windowsize / 8; + unsigned maxlazymatch = windowsize >= 8192 ? MAX_SUPPORTED_DEFLATE_LENGTH : 64; + + unsigned usezeros = 1; /*not sure if setting it to false for windowsize < 8192 is better or worse*/ + unsigned numzeros = 0; + + unsigned offset; /*the offset represents the distance in LZ77 terminology*/ + unsigned length; + unsigned lazy = 0; + unsigned lazylength = 0, lazyoffset = 0; + unsigned hashval; + unsigned current_offset, current_length; + unsigned prev_offset; + const unsigned char *lastptr, *foreptr, *backptr; + unsigned hashpos; + + if(windowsize == 0 || windowsize > 32768) return 60; /*error: windowsize smaller/larger than allowed*/ + if((windowsize & (windowsize - 1)) != 0) return 90; /*error: must be power of two*/ + + if(nicematch > MAX_SUPPORTED_DEFLATE_LENGTH) nicematch = MAX_SUPPORTED_DEFLATE_LENGTH; + + for(pos = inpos; pos < insize; ++pos) { + size_t wpos = pos & (windowsize - 1); /*position for in 'circular' hash buffers*/ + unsigned chainlength = 0; + + hashval = getHash(in, insize, pos); + + if(usezeros && hashval == 0) { + if(numzeros == 0) numzeros = countZeros(in, insize, pos); + else if(pos + numzeros > insize || in[pos + numzeros - 1] != 0) --numzeros; + } else { + numzeros = 0; + } + + updateHashChain(hash, wpos, hashval, numzeros); + + /*the length and offset found for the current position*/ + length = 0; + offset = 0; + + hashpos = hash->chain[wpos]; + + lastptr = &in[insize < pos + MAX_SUPPORTED_DEFLATE_LENGTH ? insize : pos + MAX_SUPPORTED_DEFLATE_LENGTH]; + + /*search for the longest string*/ + prev_offset = 0; + for(;;) { + if(chainlength++ >= maxchainlength) break; + current_offset = (unsigned)(hashpos <= wpos ? wpos - hashpos : wpos - hashpos + windowsize); + + if(current_offset < prev_offset) break; /*stop when went completely around the circular buffer*/ + prev_offset = current_offset; + if(current_offset > 0) { + /*test the next characters*/ + foreptr = &in[pos]; + backptr = &in[pos - current_offset]; + + /*common case in PNGs is lots of zeros. Quickly skip over them as a speedup*/ + if(numzeros >= 3) { + unsigned skip = hash->zeros[hashpos]; + if(skip > numzeros) skip = numzeros; + backptr += skip; + foreptr += skip; + } + + while(foreptr != lastptr && *backptr == *foreptr) /*maximum supported length by deflate is max length*/ { + ++backptr; + ++foreptr; + } + current_length = (unsigned)(foreptr - &in[pos]); + + if(current_length > length) { + length = current_length; /*the longest length*/ + offset = current_offset; /*the offset that is related to this longest length*/ + /*jump out once a length of max length is found (speed gain). This also jumps + out if length is MAX_SUPPORTED_DEFLATE_LENGTH*/ + if(current_length >= nicematch) break; + } + } + + if(hashpos == hash->chain[hashpos]) break; + + if(numzeros >= 3 && length > numzeros) { + hashpos = hash->chainz[hashpos]; + if(hash->zeros[hashpos] != numzeros) break; + } else { + hashpos = hash->chain[hashpos]; + /*outdated hash value, happens if particular value was not encountered in whole last window*/ + if(hash->val[hashpos] != (int)hashval) break; + } + } + + if(lazymatching) { + if(!lazy && length >= 3 && length <= maxlazymatch && length < MAX_SUPPORTED_DEFLATE_LENGTH) { + lazy = 1; + lazylength = length; + lazyoffset = offset; + continue; /*try the next byte*/ + } + if(lazy) { + lazy = 0; + if(pos == 0) ERROR_BREAK(81); + if(length > lazylength + 1) { + /*push the previous character as literal*/ + if(!uivector_push_back(out, in[pos - 1])) ERROR_BREAK(83 /*alloc fail*/); + } else { + length = lazylength; + offset = lazyoffset; + hash->head[hashval] = -1; /*the same hashchain update will be done, this ensures no wrong alteration*/ + hash->headz[numzeros] = -1; /*idem*/ + --pos; + } + } + } + if(length >= 3 && offset > windowsize) ERROR_BREAK(86 /*too big (or overflown negative) offset*/); + + /*encode it as length/distance pair or literal value*/ + if(length < 3) /*only lengths of 3 or higher are supported as length/distance pair*/ { + if(!uivector_push_back(out, in[pos])) ERROR_BREAK(83 /*alloc fail*/); + } else if(length < minmatch || (length == 3 && offset > 4096)) { + /*compensate for the fact that longer offsets have more extra bits, a + length of only 3 may be not worth it then*/ + if(!uivector_push_back(out, in[pos])) ERROR_BREAK(83 /*alloc fail*/); + } else { + addLengthDistance(out, length, offset); + for(i = 1; i < length; ++i) { + ++pos; + wpos = pos & (windowsize - 1); + hashval = getHash(in, insize, pos); + if(usezeros && hashval == 0) { + if(numzeros == 0) numzeros = countZeros(in, insize, pos); + else if(pos + numzeros > insize || in[pos + numzeros - 1] != 0) --numzeros; + } else { + numzeros = 0; + } + updateHashChain(hash, wpos, hashval, numzeros); + } + } + } /*end of the loop through each character of input*/ + + return error; +} + +/* /////////////////////////////////////////////////////////////////////////// */ + +static unsigned deflateNoCompression(ucvector* out, const unsigned char* data, size_t datasize) { + /*non compressed deflate block data: 1 bit BFINAL,2 bits BTYPE,(5 bits): it jumps to start of next byte, + 2 bytes LEN, 2 bytes NLEN, LEN bytes literal DATA*/ + + size_t i, j, numdeflateblocks = (datasize + 65534) / 65535; + unsigned datapos = 0; + for(i = 0; i != numdeflateblocks; ++i) { + unsigned BFINAL, BTYPE, LEN, NLEN; + unsigned char firstbyte; + + BFINAL = (i == numdeflateblocks - 1); + BTYPE = 0; + + firstbyte = (unsigned char)(BFINAL + ((BTYPE & 1) << 1) + ((BTYPE & 2) << 1)); + ucvector_push_back(out, firstbyte); + + LEN = 65535; + if(datasize - datapos < 65535) LEN = (unsigned)datasize - datapos; + NLEN = 65535 - LEN; + + ucvector_push_back(out, (unsigned char)(LEN & 255)); + ucvector_push_back(out, (unsigned char)(LEN >> 8)); + ucvector_push_back(out, (unsigned char)(NLEN & 255)); + ucvector_push_back(out, (unsigned char)(NLEN >> 8)); + + /*Decompressed data*/ + for(j = 0; j < 65535 && datapos < datasize; ++j) { + ucvector_push_back(out, data[datapos++]); + } + } + + return 0; +} + +/* +write the lz77-encoded data, which has lit, len and dist codes, to compressed stream using huffman trees. +tree_ll: the tree for lit and len codes. +tree_d: the tree for distance codes. +*/ +static void writeLZ77data(size_t* bp, ucvector* out, const uivector* lz77_encoded, + const HuffmanTree* tree_ll, const HuffmanTree* tree_d) { + size_t i = 0; + for(i = 0; i != lz77_encoded->size; ++i) { + unsigned val = lz77_encoded->data[i]; + addHuffmanSymbol(bp, out, HuffmanTree_getCode(tree_ll, val), HuffmanTree_getLength(tree_ll, val)); + if(val > 256) /*for a length code, 3 more things have to be added*/ { + unsigned length_index = val - FIRST_LENGTH_CODE_INDEX; + unsigned n_length_extra_bits = LENGTHEXTRA[length_index]; + unsigned length_extra_bits = lz77_encoded->data[++i]; + + unsigned distance_code = lz77_encoded->data[++i]; + + unsigned distance_index = distance_code; + unsigned n_distance_extra_bits = DISTANCEEXTRA[distance_index]; + unsigned distance_extra_bits = lz77_encoded->data[++i]; + + addBitsToStream(bp, out, length_extra_bits, n_length_extra_bits); + addHuffmanSymbol(bp, out, HuffmanTree_getCode(tree_d, distance_code), + HuffmanTree_getLength(tree_d, distance_code)); + addBitsToStream(bp, out, distance_extra_bits, n_distance_extra_bits); + } + } +} + +/*Deflate for a block of type "dynamic", that is, with freely, optimally, created huffman trees*/ +static unsigned deflateDynamic(ucvector* out, size_t* bp, Hash* hash, + const unsigned char* data, size_t datapos, size_t dataend, + const LodePNGCompressSettings* settings, unsigned final) { + unsigned error = 0; + + /* + A block is compressed as follows: The PNG data is lz77 encoded, resulting in + literal bytes and length/distance pairs. This is then huffman compressed with + two huffman trees. One huffman tree is used for the lit and len values ("ll"), + another huffman tree is used for the dist values ("d"). These two trees are + stored using their code lengths, and to compress even more these code lengths + are also run-length encoded and huffman compressed. This gives a huffman tree + of code lengths "cl". The code lenghts used to describe this third tree are + the code length code lengths ("clcl"). + */ + + /*The lz77 encoded data, represented with integers since there will also be length and distance codes in it*/ + uivector lz77_encoded; + HuffmanTree tree_ll; /*tree for lit,len values*/ + HuffmanTree tree_d; /*tree for distance codes*/ + HuffmanTree tree_cl; /*tree for encoding the code lengths representing tree_ll and tree_d*/ + uivector frequencies_ll; /*frequency of lit,len codes*/ + uivector frequencies_d; /*frequency of dist codes*/ + uivector frequencies_cl; /*frequency of code length codes*/ + uivector bitlen_lld; /*lit,len,dist code lenghts (int bits), literally (without repeat codes).*/ + uivector bitlen_lld_e; /*bitlen_lld encoded with repeat codes (this is a rudemtary run length compression)*/ + /*bitlen_cl is the code length code lengths ("clcl"). The bit lengths of codes to represent tree_cl + (these are written as is in the file, it would be crazy to compress these using yet another huffman + tree that needs to be represented by yet another set of code lengths)*/ + uivector bitlen_cl; + size_t datasize = dataend - datapos; + + /* + Due to the huffman compression of huffman tree representations ("two levels"), there are some anologies: + bitlen_lld is to tree_cl what data is to tree_ll and tree_d. + bitlen_lld_e is to bitlen_lld what lz77_encoded is to data. + bitlen_cl is to bitlen_lld_e what bitlen_lld is to lz77_encoded. + */ + + unsigned BFINAL = final; + size_t numcodes_ll, numcodes_d, i; + unsigned HLIT, HDIST, HCLEN; + + uivector_init(&lz77_encoded); + HuffmanTree_init(&tree_ll); + HuffmanTree_init(&tree_d); + HuffmanTree_init(&tree_cl); + uivector_init(&frequencies_ll); + uivector_init(&frequencies_d); + uivector_init(&frequencies_cl); + uivector_init(&bitlen_lld); + uivector_init(&bitlen_lld_e); + uivector_init(&bitlen_cl); + + /*This while loop never loops due to a break at the end, it is here to + allow breaking out of it to the cleanup phase on error conditions.*/ + while(!error) { + if(settings->use_lz77) { + error = encodeLZ77(&lz77_encoded, hash, data, datapos, dataend, settings->windowsize, + settings->minmatch, settings->nicematch, settings->lazymatching); + if(error) break; + } else { + if(!uivector_resize(&lz77_encoded, datasize)) ERROR_BREAK(83 /*alloc fail*/); + for(i = datapos; i < dataend; ++i) lz77_encoded.data[i - datapos] = data[i]; /*no LZ77, but still will be Huffman compressed*/ + } + + if(!uivector_resizev(&frequencies_ll, 286, 0)) ERROR_BREAK(83 /*alloc fail*/); + if(!uivector_resizev(&frequencies_d, 30, 0)) ERROR_BREAK(83 /*alloc fail*/); + + /*Count the frequencies of lit, len and dist codes*/ + for(i = 0; i != lz77_encoded.size; ++i) { + unsigned symbol = lz77_encoded.data[i]; + ++frequencies_ll.data[symbol]; + if(symbol > 256) { + unsigned dist = lz77_encoded.data[i + 2]; + ++frequencies_d.data[dist]; + i += 3; + } + } + frequencies_ll.data[256] = 1; /*there will be exactly 1 end code, at the end of the block*/ + + /*Make both huffman trees, one for the lit and len codes, one for the dist codes*/ + error = HuffmanTree_makeFromFrequencies(&tree_ll, frequencies_ll.data, 257, frequencies_ll.size, 15); + if(error) break; + /*2, not 1, is chosen for mincodes: some buggy PNG decoders require at least 2 symbols in the dist tree*/ + error = HuffmanTree_makeFromFrequencies(&tree_d, frequencies_d.data, 2, frequencies_d.size, 15); + if(error) break; + + numcodes_ll = tree_ll.numcodes; if(numcodes_ll > 286) numcodes_ll = 286; + numcodes_d = tree_d.numcodes; if(numcodes_d > 30) numcodes_d = 30; + /*store the code lengths of both generated trees in bitlen_lld*/ + for(i = 0; i != numcodes_ll; ++i) uivector_push_back(&bitlen_lld, HuffmanTree_getLength(&tree_ll, (unsigned)i)); + for(i = 0; i != numcodes_d; ++i) uivector_push_back(&bitlen_lld, HuffmanTree_getLength(&tree_d, (unsigned)i)); + + /*run-length compress bitlen_ldd into bitlen_lld_e by using repeat codes 16 (copy length 3-6 times), + 17 (3-10 zeroes), 18 (11-138 zeroes)*/ + for(i = 0; i != (unsigned)bitlen_lld.size; ++i) { + unsigned j = 0; /*amount of repititions*/ + while(i + j + 1 < (unsigned)bitlen_lld.size && bitlen_lld.data[i + j + 1] == bitlen_lld.data[i]) ++j; + + if(bitlen_lld.data[i] == 0 && j >= 2) /*repeat code for zeroes*/ { + ++j; /*include the first zero*/ + if(j <= 10) /*repeat code 17 supports max 10 zeroes*/ { + uivector_push_back(&bitlen_lld_e, 17); + uivector_push_back(&bitlen_lld_e, j - 3); + } else /*repeat code 18 supports max 138 zeroes*/ { + if(j > 138) j = 138; + uivector_push_back(&bitlen_lld_e, 18); + uivector_push_back(&bitlen_lld_e, j - 11); + } + i += (j - 1); + } else if(j >= 3) /*repeat code for value other than zero*/ { + size_t k; + unsigned num = j / 6, rest = j % 6; + uivector_push_back(&bitlen_lld_e, bitlen_lld.data[i]); + for(k = 0; k < num; ++k) { + uivector_push_back(&bitlen_lld_e, 16); + uivector_push_back(&bitlen_lld_e, 6 - 3); + } + if(rest >= 3) { + uivector_push_back(&bitlen_lld_e, 16); + uivector_push_back(&bitlen_lld_e, rest - 3); + } + else j -= rest; + i += j; + } else /*too short to benefit from repeat code*/ { + uivector_push_back(&bitlen_lld_e, bitlen_lld.data[i]); + } + } + + /*generate tree_cl, the huffmantree of huffmantrees*/ + + if(!uivector_resizev(&frequencies_cl, NUM_CODE_LENGTH_CODES, 0)) ERROR_BREAK(83 /*alloc fail*/); + for(i = 0; i != bitlen_lld_e.size; ++i) { + ++frequencies_cl.data[bitlen_lld_e.data[i]]; + /*after a repeat code come the bits that specify the number of repetitions, + those don't need to be in the frequencies_cl calculation*/ + if(bitlen_lld_e.data[i] >= 16) ++i; + } + + error = HuffmanTree_makeFromFrequencies(&tree_cl, frequencies_cl.data, + frequencies_cl.size, frequencies_cl.size, 7); + if(error) break; + + if(!uivector_resize(&bitlen_cl, tree_cl.numcodes)) ERROR_BREAK(83 /*alloc fail*/); + for(i = 0; i != tree_cl.numcodes; ++i) { + /*lenghts of code length tree is in the order as specified by deflate*/ + bitlen_cl.data[i] = HuffmanTree_getLength(&tree_cl, CLCL_ORDER[i]); + } + while(bitlen_cl.data[bitlen_cl.size - 1] == 0 && bitlen_cl.size > 4) { + /*remove zeros at the end, but minimum size must be 4*/ + if(!uivector_resize(&bitlen_cl, bitlen_cl.size - 1)) ERROR_BREAK(83 /*alloc fail*/); + } + if(error) break; + + /* + Write everything into the output + + After the BFINAL and BTYPE, the dynamic block consists out of the following: + - 5 bits HLIT, 5 bits HDIST, 4 bits HCLEN + - (HCLEN+4)*3 bits code lengths of code length alphabet + - HLIT + 257 code lenghts of lit/length alphabet (encoded using the code length + alphabet, + possible repetition codes 16, 17, 18) + - HDIST + 1 code lengths of distance alphabet (encoded using the code length + alphabet, + possible repetition codes 16, 17, 18) + - compressed data + - 256 (end code) + */ + + /*Write block type*/ + addBitToStream(bp, out, BFINAL); + addBitToStream(bp, out, 0); /*first bit of BTYPE "dynamic"*/ + addBitToStream(bp, out, 1); /*second bit of BTYPE "dynamic"*/ + + /*write the HLIT, HDIST and HCLEN values*/ + HLIT = (unsigned)(numcodes_ll - 257); + HDIST = (unsigned)(numcodes_d - 1); + HCLEN = (unsigned)bitlen_cl.size - 4; + /*trim zeroes for HCLEN. HLIT and HDIST were already trimmed at tree creation*/ + while(!bitlen_cl.data[HCLEN + 4 - 1] && HCLEN > 0) --HCLEN; + addBitsToStream(bp, out, HLIT, 5); + addBitsToStream(bp, out, HDIST, 5); + addBitsToStream(bp, out, HCLEN, 4); + + /*write the code lenghts of the code length alphabet*/ + for(i = 0; i != HCLEN + 4; ++i) addBitsToStream(bp, out, bitlen_cl.data[i], 3); + + /*write the lenghts of the lit/len AND the dist alphabet*/ + for(i = 0; i != bitlen_lld_e.size; ++i) { + addHuffmanSymbol(bp, out, HuffmanTree_getCode(&tree_cl, bitlen_lld_e.data[i]), + HuffmanTree_getLength(&tree_cl, bitlen_lld_e.data[i])); + /*extra bits of repeat codes*/ + if(bitlen_lld_e.data[i] == 16) addBitsToStream(bp, out, bitlen_lld_e.data[++i], 2); + else if(bitlen_lld_e.data[i] == 17) addBitsToStream(bp, out, bitlen_lld_e.data[++i], 3); + else if(bitlen_lld_e.data[i] == 18) addBitsToStream(bp, out, bitlen_lld_e.data[++i], 7); + } + + /*write the compressed data symbols*/ + writeLZ77data(bp, out, &lz77_encoded, &tree_ll, &tree_d); + /*error: the length of the end code 256 must be larger than 0*/ + if(HuffmanTree_getLength(&tree_ll, 256) == 0) ERROR_BREAK(64); + + /*write the end code*/ + addHuffmanSymbol(bp, out, HuffmanTree_getCode(&tree_ll, 256), HuffmanTree_getLength(&tree_ll, 256)); + + break; /*end of error-while*/ + } + + /*cleanup*/ + uivector_cleanup(&lz77_encoded); + HuffmanTree_cleanup(&tree_ll); + HuffmanTree_cleanup(&tree_d); + HuffmanTree_cleanup(&tree_cl); + uivector_cleanup(&frequencies_ll); + uivector_cleanup(&frequencies_d); + uivector_cleanup(&frequencies_cl); + uivector_cleanup(&bitlen_lld_e); + uivector_cleanup(&bitlen_lld); + uivector_cleanup(&bitlen_cl); + + return error; +} + +static unsigned deflateFixed(ucvector* out, size_t* bp, Hash* hash, + const unsigned char* data, + size_t datapos, size_t dataend, + const LodePNGCompressSettings* settings, unsigned final) { + HuffmanTree tree_ll; /*tree for literal values and length codes*/ + HuffmanTree tree_d; /*tree for distance codes*/ + + unsigned BFINAL = final; + unsigned error = 0; + size_t i; + + HuffmanTree_init(&tree_ll); + HuffmanTree_init(&tree_d); + + generateFixedLitLenTree(&tree_ll); + generateFixedDistanceTree(&tree_d); + + addBitToStream(bp, out, BFINAL); + addBitToStream(bp, out, 1); /*first bit of BTYPE*/ + addBitToStream(bp, out, 0); /*second bit of BTYPE*/ + + if(settings->use_lz77) /*LZ77 encoded*/ { + uivector lz77_encoded; + uivector_init(&lz77_encoded); + error = encodeLZ77(&lz77_encoded, hash, data, datapos, dataend, settings->windowsize, + settings->minmatch, settings->nicematch, settings->lazymatching); + if(!error) writeLZ77data(bp, out, &lz77_encoded, &tree_ll, &tree_d); + uivector_cleanup(&lz77_encoded); + } else /*no LZ77, but still will be Huffman compressed*/ { + for(i = datapos; i < dataend; ++i) { + addHuffmanSymbol(bp, out, HuffmanTree_getCode(&tree_ll, data[i]), HuffmanTree_getLength(&tree_ll, data[i])); + } + } + /*add END code*/ + if(!error) addHuffmanSymbol(bp, out, HuffmanTree_getCode(&tree_ll, 256), HuffmanTree_getLength(&tree_ll, 256)); + + /*cleanup*/ + HuffmanTree_cleanup(&tree_ll); + HuffmanTree_cleanup(&tree_d); + + return error; +} + +static unsigned lodepng_deflatev(ucvector* out, const unsigned char* in, size_t insize, + const LodePNGCompressSettings* settings) { + unsigned error = 0; + size_t i, blocksize, numdeflateblocks; + size_t bp = 0; /*the bit pointer*/ + Hash hash; + + if(settings->btype > 2) return 61; + else if(settings->btype == 0) return deflateNoCompression(out, in, insize); + else if(settings->btype == 1) blocksize = insize; + else /*if(settings->btype == 2)*/ { + /*on PNGs, deflate blocks of 65-262k seem to give most dense encoding*/ + blocksize = insize / 8 + 8; + if(blocksize < 65536) blocksize = 65536; + if(blocksize > 262144) blocksize = 262144; + } + + numdeflateblocks = (insize + blocksize - 1) / blocksize; + if(numdeflateblocks == 0) numdeflateblocks = 1; + + error = hash_init(&hash, settings->windowsize); + if(error) return error; + + for(i = 0; i != numdeflateblocks && !error; ++i) { + unsigned final = (i == numdeflateblocks - 1); + size_t start = i * blocksize; + size_t end = start + blocksize; + if(end > insize) end = insize; + + if(settings->btype == 1) error = deflateFixed(out, &bp, &hash, in, start, end, settings, final); + else if(settings->btype == 2) error = deflateDynamic(out, &bp, &hash, in, start, end, settings, final); + } + + hash_cleanup(&hash); + + return error; +} + +unsigned lodepng_deflate(unsigned char** out, size_t* outsize, + const unsigned char* in, size_t insize, + const LodePNGCompressSettings* settings) { + unsigned error; + ucvector v; + ucvector_init_buffer(&v, *out, *outsize); + error = lodepng_deflatev(&v, in, insize, settings); + *out = v.data; + *outsize = v.size; + return error; +} + +static unsigned deflate(unsigned char** out, size_t* outsize, + const unsigned char* in, size_t insize, + const LodePNGCompressSettings* settings) { + if(settings->custom_deflate) { + return settings->custom_deflate(out, outsize, in, insize, settings); + } else { + return lodepng_deflate(out, outsize, in, insize, settings); + } +} + +#endif /*LODEPNG_COMPILE_DECODER*/ + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / Adler32 */ +/* ////////////////////////////////////////////////////////////////////////// */ + +static unsigned update_adler32(unsigned adler, const unsigned char* data, unsigned len) { + unsigned s1 = adler & 0xffff; + unsigned s2 = (adler >> 16) & 0xffff; + + while(len > 0) { + /*at least 5552 sums can be done before the sums overflow, saving a lot of module divisions*/ + unsigned amount = len > 5552 ? 5552 : len; + len -= amount; + while(amount > 0) { + s1 += (*data++); + s2 += s1; + --amount; + } + s1 %= 65521; + s2 %= 65521; + } + + return (s2 << 16) | s1; +} + +/*Return the adler32 of the bytes data[0..len-1]*/ +static unsigned adler32(const unsigned char* data, unsigned len) { + return update_adler32(1L, data, len); +} + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / Zlib / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +#ifdef LODEPNG_COMPILE_DECODER + +unsigned lodepng_zlib_decompress(unsigned char** out, size_t* outsize, const unsigned char* in, + size_t insize, const LodePNGDecompressSettings* settings) { + unsigned error = 0; + unsigned CM, CINFO, FDICT; + + if(insize < 2) return 53; /*error, size of zlib data too small*/ + /*read information from zlib header*/ + if((in[0] * 256 + in[1]) % 31 != 0) { + /*error: 256 * in[0] + in[1] must be a multiple of 31, the FCHECK value is supposed to be made that way*/ + return 24; + } + + CM = in[0] & 15; + CINFO = (in[0] >> 4) & 15; + /*FCHECK = in[1] & 31;*/ /*FCHECK is already tested above*/ + FDICT = (in[1] >> 5) & 1; + /*FLEVEL = (in[1] >> 6) & 3;*/ /*FLEVEL is not used here*/ + + if(CM != 8 || CINFO > 7) { + /*error: only compression method 8: inflate with sliding window of 32k is supported by the PNG spec*/ + return 25; + } + if(FDICT != 0) { + /*error: the specification of PNG says about the zlib stream: + "The additional flags shall not specify a preset dictionary."*/ + return 26; + } + + error = inflate(out, outsize, in + 2, insize - 2, settings); + if(error) return error; + + if(!settings->ignore_adler32) { + unsigned ADLER32 = lodepng_read32bitInt(&in[insize - 4]); + unsigned checksum = adler32(*out, (unsigned)(*outsize)); + if(checksum != ADLER32) return 58; /*error, adler checksum not correct, data must be corrupted*/ + } + + return 0; /*no error*/ +} + +static unsigned zlib_decompress(unsigned char** out, size_t* outsize, const unsigned char* in, + size_t insize, const LodePNGDecompressSettings* settings) { + if(settings->custom_zlib) { + return settings->custom_zlib(out, outsize, in, insize, settings); + } else { + return lodepng_zlib_decompress(out, outsize, in, insize, settings); + } +} + +#endif /*LODEPNG_COMPILE_DECODER*/ + +#ifdef LODEPNG_COMPILE_ENCODER + +unsigned lodepng_zlib_compress(unsigned char** out, size_t* outsize, const unsigned char* in, + size_t insize, const LodePNGCompressSettings* settings) { + /*initially, *out must be NULL and outsize 0, if you just give some random *out + that's pointing to a non allocated buffer, this'll crash*/ + ucvector outv; + size_t i; + unsigned error; + unsigned char* deflatedata = 0; + size_t deflatesize = 0; + + /*zlib data: 1 byte CMF (CM+CINFO), 1 byte FLG, deflate data, 4 byte ADLER32 checksum of the Decompressed data*/ + unsigned CMF = 120; /*0b01111000: CM 8, CINFO 7. With CINFO 7, any window size up to 32768 can be used.*/ + unsigned FLEVEL = 0; + unsigned FDICT = 0; + unsigned CMFFLG = 256 * CMF + FDICT * 32 + FLEVEL * 64; + unsigned FCHECK = 31 - CMFFLG % 31; + CMFFLG += FCHECK; + + /*ucvector-controlled version of the output buffer, for dynamic array*/ + ucvector_init_buffer(&outv, *out, *outsize); + + ucvector_push_back(&outv, (unsigned char)(CMFFLG >> 8)); + ucvector_push_back(&outv, (unsigned char)(CMFFLG & 255)); + + error = deflate(&deflatedata, &deflatesize, in, insize, settings); + + if(!error) { + unsigned ADLER32 = adler32(in, (unsigned)insize); + for(i = 0; i != deflatesize; ++i) ucvector_push_back(&outv, deflatedata[i]); + lodepng_free(deflatedata); + lodepng_add32bitInt(&outv, ADLER32); + } + + *out = outv.data; + *outsize = outv.size; + + return error; +} + +/* compress using the default or custom zlib function */ +static unsigned zlib_compress(unsigned char** out, size_t* outsize, const unsigned char* in, + size_t insize, const LodePNGCompressSettings* settings) { + if(settings->custom_zlib) { + return settings->custom_zlib(out, outsize, in, insize, settings); + } else { + return lodepng_zlib_compress(out, outsize, in, insize, settings); + } +} + +#endif /*LODEPNG_COMPILE_ENCODER*/ + +#else /*no LODEPNG_COMPILE_ZLIB*/ + +#ifdef LODEPNG_COMPILE_DECODER +static unsigned zlib_decompress(unsigned char** out, size_t* outsize, const unsigned char* in, + size_t insize, const LodePNGDecompressSettings* settings) { + if(!settings->custom_zlib) return 87; /*no custom zlib function provided */ + return settings->custom_zlib(out, outsize, in, insize, settings); +} +#endif /*LODEPNG_COMPILE_DECODER*/ +#ifdef LODEPNG_COMPILE_ENCODER +static unsigned zlib_compress(unsigned char** out, size_t* outsize, const unsigned char* in, + size_t insize, const LodePNGCompressSettings* settings) { + if(!settings->custom_zlib) return 87; /*no custom zlib function provided */ + return settings->custom_zlib(out, outsize, in, insize, settings); +} +#endif /*LODEPNG_COMPILE_ENCODER*/ + +#endif /*LODEPNG_COMPILE_ZLIB*/ + +/* ////////////////////////////////////////////////////////////////////////// */ + +#ifdef LODEPNG_COMPILE_ENCODER + +/*this is a good tradeoff between speed and compression ratio*/ +#define DEFAULT_WINDOWSIZE 2048 + +void lodepng_compress_settings_init(LodePNGCompressSettings* settings) { + /*compress with dynamic huffman tree (not in the mathematical sense, just not the predefined one)*/ + settings->btype = 2; + settings->use_lz77 = 1; + settings->windowsize = DEFAULT_WINDOWSIZE; + settings->minmatch = 3; + settings->nicematch = 128; + settings->lazymatching = 1; + + settings->custom_zlib = 0; + settings->custom_deflate = 0; + settings->custom_context = 0; +} + +const LodePNGCompressSettings lodepng_default_compress_settings = {2, 1, DEFAULT_WINDOWSIZE, 3, 128, 1, 0, 0, 0}; + + +#endif /*LODEPNG_COMPILE_ENCODER*/ + +#ifdef LODEPNG_COMPILE_DECODER + +void lodepng_decompress_settings_init(LodePNGDecompressSettings* settings) { + settings->ignore_adler32 = 0; + + settings->custom_zlib = 0; + settings->custom_inflate = 0; + settings->custom_context = 0; +} + +const LodePNGDecompressSettings lodepng_default_decompress_settings = {0, 0, 0, 0}; + +#endif /*LODEPNG_COMPILE_DECODER*/ + +/* ////////////////////////////////////////////////////////////////////////// */ +/* ////////////////////////////////////////////////////////////////////////// */ +/* // End of Zlib related code. Begin of PNG related code. // */ +/* ////////////////////////////////////////////////////////////////////////// */ +/* ////////////////////////////////////////////////////////////////////////// */ + +#ifdef LODEPNG_COMPILE_PNG + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / CRC32 / */ +/* ////////////////////////////////////////////////////////////////////////// */ + + +#ifndef LODEPNG_NO_COMPILE_CRC +/* CRC polynomial: 0xedb88320 */ +static unsigned lodepng_crc32_table[256] = { + 0u, 1996959894u, 3993919788u, 2567524794u, 124634137u, 1886057615u, 3915621685u, 2657392035u, + 249268274u, 2044508324u, 3772115230u, 2547177864u, 162941995u, 2125561021u, 3887607047u, 2428444049u, + 498536548u, 1789927666u, 4089016648u, 2227061214u, 450548861u, 1843258603u, 4107580753u, 2211677639u, + 325883990u, 1684777152u, 4251122042u, 2321926636u, 335633487u, 1661365465u, 4195302755u, 2366115317u, + 997073096u, 1281953886u, 3579855332u, 2724688242u, 1006888145u, 1258607687u, 3524101629u, 2768942443u, + 901097722u, 1119000684u, 3686517206u, 2898065728u, 853044451u, 1172266101u, 3705015759u, 2882616665u, + 651767980u, 1373503546u, 3369554304u, 3218104598u, 565507253u, 1454621731u, 3485111705u, 3099436303u, + 671266974u, 1594198024u, 3322730930u, 2970347812u, 795835527u, 1483230225u, 3244367275u, 3060149565u, + 1994146192u, 31158534u, 2563907772u, 4023717930u, 1907459465u, 112637215u, 2680153253u, 3904427059u, + 2013776290u, 251722036u, 2517215374u, 3775830040u, 2137656763u, 141376813u, 2439277719u, 3865271297u, + 1802195444u, 476864866u, 2238001368u, 4066508878u, 1812370925u, 453092731u, 2181625025u, 4111451223u, + 1706088902u, 314042704u, 2344532202u, 4240017532u, 1658658271u, 366619977u, 2362670323u, 4224994405u, + 1303535960u, 984961486u, 2747007092u, 3569037538u, 1256170817u, 1037604311u, 2765210733u, 3554079995u, + 1131014506u, 879679996u, 2909243462u, 3663771856u, 1141124467u, 855842277u, 2852801631u, 3708648649u, + 1342533948u, 654459306u, 3188396048u, 3373015174u, 1466479909u, 544179635u, 3110523913u, 3462522015u, + 1591671054u, 702138776u, 2966460450u, 3352799412u, 1504918807u, 783551873u, 3082640443u, 3233442989u, + 3988292384u, 2596254646u, 62317068u, 1957810842u, 3939845945u, 2647816111u, 81470997u, 1943803523u, + 3814918930u, 2489596804u, 225274430u, 2053790376u, 3826175755u, 2466906013u, 167816743u, 2097651377u, + 4027552580u, 2265490386u, 503444072u, 1762050814u, 4150417245u, 2154129355u, 426522225u, 1852507879u, + 4275313526u, 2312317920u, 282753626u, 1742555852u, 4189708143u, 2394877945u, 397917763u, 1622183637u, + 3604390888u, 2714866558u, 953729732u, 1340076626u, 3518719985u, 2797360999u, 1068828381u, 1219638859u, + 3624741850u, 2936675148u, 906185462u, 1090812512u, 3747672003u, 2825379669u, 829329135u, 1181335161u, + 3412177804u, 3160834842u, 628085408u, 1382605366u, 3423369109u, 3138078467u, 570562233u, 1426400815u, + 3317316542u, 2998733608u, 733239954u, 1555261956u, 3268935591u, 3050360625u, 752459403u, 1541320221u, + 2607071920u, 3965973030u, 1969922972u, 40735498u, 2617837225u, 3943577151u, 1913087877u, 83908371u, + 2512341634u, 3803740692u, 2075208622u, 213261112u, 2463272603u, 3855990285u, 2094854071u, 198958881u, + 2262029012u, 4057260610u, 1759359992u, 534414190u, 2176718541u, 4139329115u, 1873836001u, 414664567u, + 2282248934u, 4279200368u, 1711684554u, 285281116u, 2405801727u, 4167216745u, 1634467795u, 376229701u, + 2685067896u, 3608007406u, 1308918612u, 956543938u, 2808555105u, 3495958263u, 1231636301u, 1047427035u, + 2932959818u, 3654703836u, 1088359270u, 936918000u, 2847714899u, 3736837829u, 1202900863u, 817233897u, + 3183342108u, 3401237130u, 1404277552u, 615818150u, 3134207493u, 3453421203u, 1423857449u, 601450431u, + 3009837614u, 3294710456u, 1567103746u, 711928724u, 3020668471u, 3272380065u, 1510334235u, 755167117u +}; + +/*Return the CRC of the bytes buf[0..len-1].*/ +unsigned lodepng_crc32(const unsigned char* data, size_t length) { + unsigned r = 0xffffffffu; + size_t i; + for(i = 0; i < length; ++i) { + r = lodepng_crc32_table[(r ^ data[i]) & 0xff] ^ (r >> 8); + } + return r ^ 0xffffffffu; +} +#else /* !LODEPNG_NO_COMPILE_CRC */ +unsigned lodepng_crc32(const unsigned char* data, size_t length); +#endif /* !LODEPNG_NO_COMPILE_CRC */ + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / Reading and writing single bits and bytes from/to stream for LodePNG / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +static unsigned char readBitFromReversedStream(size_t* bitpointer, const unsigned char* bitstream) { + unsigned char result = (unsigned char)((bitstream[(*bitpointer) >> 3] >> (7 - ((*bitpointer) & 0x7))) & 1); + ++(*bitpointer); + return result; +} + +static unsigned readBitsFromReversedStream(size_t* bitpointer, const unsigned char* bitstream, size_t nbits) { + unsigned result = 0; + size_t i; + for(i = 0 ; i < nbits; ++i) { + result <<= 1; + result |= (unsigned)readBitFromReversedStream(bitpointer, bitstream); + } + return result; +} + +#ifdef LODEPNG_COMPILE_DECODER +static void setBitOfReversedStream0(size_t* bitpointer, unsigned char* bitstream, unsigned char bit) { + /*the current bit in bitstream must be 0 for this to work*/ + if(bit) { + /*earlier bit of huffman code is in a lesser significant bit of an earlier byte*/ + bitstream[(*bitpointer) >> 3] |= (bit << (7 - ((*bitpointer) & 0x7))); + } + ++(*bitpointer); +} +#endif /*LODEPNG_COMPILE_DECODER*/ + +static void setBitOfReversedStream(size_t* bitpointer, unsigned char* bitstream, unsigned char bit) { + /*the current bit in bitstream may be 0 or 1 for this to work*/ + if(bit == 0) bitstream[(*bitpointer) >> 3] &= (unsigned char)(~(1 << (7 - ((*bitpointer) & 0x7)))); + else bitstream[(*bitpointer) >> 3] |= (1 << (7 - ((*bitpointer) & 0x7))); + ++(*bitpointer); +} + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / PNG chunks / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +unsigned lodepng_chunk_length(const unsigned char* chunk) { + return lodepng_read32bitInt(&chunk[0]); +} + +void lodepng_chunk_type(char type[5], const unsigned char* chunk) { + unsigned i; + for(i = 0; i != 4; ++i) type[i] = (char)chunk[4 + i]; + type[4] = 0; /*null termination char*/ +} + +unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type) { + if(strlen(type) != 4) return 0; + return (chunk[4] == type[0] && chunk[5] == type[1] && chunk[6] == type[2] && chunk[7] == type[3]); +} + +unsigned char lodepng_chunk_ancillary(const unsigned char* chunk) { + return((chunk[4] & 32) != 0); +} + +unsigned char lodepng_chunk_private(const unsigned char* chunk) { + return((chunk[6] & 32) != 0); +} + +unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk) { + return((chunk[7] & 32) != 0); +} + +unsigned char* lodepng_chunk_data(unsigned char* chunk) { + return &chunk[8]; +} + +const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk) { + return &chunk[8]; +} + +unsigned lodepng_chunk_check_crc(const unsigned char* chunk) { + unsigned length = lodepng_chunk_length(chunk); + unsigned CRC = lodepng_read32bitInt(&chunk[length + 8]); + /*the CRC is taken of the data and the 4 chunk type letters, not the length*/ + unsigned checksum = lodepng_crc32(&chunk[4], length + 4); + if(CRC != checksum) return 1; + else return 0; +} + +void lodepng_chunk_generate_crc(unsigned char* chunk) { + unsigned length = lodepng_chunk_length(chunk); + unsigned CRC = lodepng_crc32(&chunk[4], length + 4); + lodepng_set32bitInt(chunk + 8 + length, CRC); +} + +unsigned char* lodepng_chunk_next(unsigned char* chunk) { + if(chunk[0] == 0x89 && chunk[1] == 0x50 && chunk[2] == 0x4e && chunk[3] == 0x47 + && chunk[4] == 0x0d && chunk[5] == 0x0a && chunk[6] == 0x1a && chunk[7] == 0x0a) { + /* Is PNG magic header at start of PNG file. Jump to first actual chunk. */ + return chunk + 8; + } else { + unsigned total_chunk_length = lodepng_chunk_length(chunk) + 12; + return chunk + total_chunk_length; + } +} + +const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk) { + if(chunk[0] == 0x89 && chunk[1] == 0x50 && chunk[2] == 0x4e && chunk[3] == 0x47 + && chunk[4] == 0x0d && chunk[5] == 0x0a && chunk[6] == 0x1a && chunk[7] == 0x0a) { + /* Is PNG magic header at start of PNG file. Jump to first actual chunk. */ + return chunk + 8; + } else { + unsigned total_chunk_length = lodepng_chunk_length(chunk) + 12; + return chunk + total_chunk_length; + } +} + +unsigned char* lodepng_chunk_find(unsigned char* chunk, const unsigned char* end, const char type[5]) { + for(;;) { + if(chunk + 12 >= end) return 0; + if(lodepng_chunk_type_equals(chunk, type)) return chunk; + chunk = lodepng_chunk_next(chunk); + } +} + +const unsigned char* lodepng_chunk_find_const(const unsigned char* chunk, const unsigned char* end, const char type[5]) { + for(;;) { + if(chunk + 12 >= end) return 0; + if(lodepng_chunk_type_equals(chunk, type)) return chunk; + chunk = lodepng_chunk_next_const(chunk); + } +} + +unsigned lodepng_chunk_append(unsigned char** out, size_t* outlength, const unsigned char* chunk) { + unsigned i; + unsigned total_chunk_length = lodepng_chunk_length(chunk) + 12; + unsigned char *chunk_start, *new_buffer; + size_t new_length = (*outlength) + total_chunk_length; + if(new_length < total_chunk_length || new_length < (*outlength)) return 77; /*integer overflow happened*/ + + new_buffer = (unsigned char*)lodepng_realloc(*out, new_length); + if(!new_buffer) return 83; /*alloc fail*/ + (*out) = new_buffer; + (*outlength) = new_length; + chunk_start = &(*out)[new_length - total_chunk_length]; + + for(i = 0; i != total_chunk_length; ++i) chunk_start[i] = chunk[i]; + + return 0; +} + +unsigned lodepng_chunk_create(unsigned char** out, size_t* outlength, unsigned length, + const char* type, const unsigned char* data) { + unsigned i; + unsigned char *chunk, *new_buffer; + size_t new_length = (*outlength) + length + 12; + if(new_length < length + 12 || new_length < (*outlength)) return 77; /*integer overflow happened*/ + new_buffer = (unsigned char*)lodepng_realloc(*out, new_length); + if(!new_buffer) return 83; /*alloc fail*/ + (*out) = new_buffer; + (*outlength) = new_length; + chunk = &(*out)[(*outlength) - length - 12]; + + /*1: length*/ + lodepng_set32bitInt(chunk, (unsigned)length); + + /*2: chunk name (4 letters)*/ + chunk[4] = (unsigned char)type[0]; + chunk[5] = (unsigned char)type[1]; + chunk[6] = (unsigned char)type[2]; + chunk[7] = (unsigned char)type[3]; + + /*3: the data*/ + for(i = 0; i != length; ++i) chunk[8 + i] = data[i]; + + /*4: CRC (of the chunkname characters and the data)*/ + lodepng_chunk_generate_crc(chunk); + + return 0; +} + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / Color types and such / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +/*return type is a LodePNG error code*/ +static unsigned checkColorValidity(LodePNGColorType colortype, unsigned bd) /*bd = bitdepth*/ { + switch(colortype) { + case 0: if(!(bd == 1 || bd == 2 || bd == 4 || bd == 8 || bd == 16)) return 37; break; /*gray*/ + case 2: if(!( bd == 8 || bd == 16)) return 37; break; /*RGB*/ + case 3: if(!(bd == 1 || bd == 2 || bd == 4 || bd == 8 )) return 37; break; /*palette*/ + case 4: if(!( bd == 8 || bd == 16)) return 37; break; /*gray + alpha*/ + case 6: if(!( bd == 8 || bd == 16)) return 37; break; /*RGBA*/ + default: return 31; + } + return 0; /*allowed color type / bits combination*/ +} + +static unsigned getNumColorChannels(LodePNGColorType colortype) { + switch(colortype) { + case 0: return 1; /*gray*/ + case 2: return 3; /*RGB*/ + case 3: return 1; /*palette*/ + case 4: return 2; /*gray + alpha*/ + case 6: return 4; /*RGBA*/ + } + return 0; /*unexisting color type*/ +} + +static unsigned lodepng_get_bpp_lct(LodePNGColorType colortype, unsigned bitdepth) { + /*bits per pixel is amount of channels * bits per channel*/ + return getNumColorChannels(colortype) * bitdepth; +} + +/* ////////////////////////////////////////////////////////////////////////// */ + +void lodepng_color_mode_init(LodePNGColorMode* info) { + info->key_defined = 0; + info->key_r = info->key_g = info->key_b = 0; + info->colortype = LCT_RGBA; + info->bitdepth = 8; + info->palette = 0; + info->palettesize = 0; +} + +void lodepng_color_mode_cleanup(LodePNGColorMode* info) { + lodepng_palette_clear(info); +} + +unsigned lodepng_color_mode_copy(LodePNGColorMode* dest, const LodePNGColorMode* source) { + size_t i; + lodepng_color_mode_cleanup(dest); + *dest = *source; + if(source->palette) { + dest->palette = (unsigned char*)lodepng_malloc(1024); + if(!dest->palette && source->palettesize) return 83; /*alloc fail*/ + for(i = 0; i != source->palettesize * 4; ++i) dest->palette[i] = source->palette[i]; + } + return 0; +} + +LodePNGColorMode lodepng_color_mode_make(LodePNGColorType colortype, unsigned bitdepth) { + LodePNGColorMode result; + lodepng_color_mode_init(&result); + result.colortype = colortype; + result.bitdepth = bitdepth; + return result; +} + +static int lodepng_color_mode_equal(const LodePNGColorMode* a, const LodePNGColorMode* b) { + size_t i; + if(a->colortype != b->colortype) return 0; + if(a->bitdepth != b->bitdepth) return 0; + if(a->key_defined != b->key_defined) return 0; + if(a->key_defined) { + if(a->key_r != b->key_r) return 0; + if(a->key_g != b->key_g) return 0; + if(a->key_b != b->key_b) return 0; + } + if(a->palettesize != b->palettesize) return 0; + for(i = 0; i != a->palettesize * 4; ++i) { + if(a->palette[i] != b->palette[i]) return 0; + } + return 1; +} + +void lodepng_palette_clear(LodePNGColorMode* info) { + if(info->palette) lodepng_free(info->palette); + info->palette = 0; + info->palettesize = 0; +} + +unsigned lodepng_palette_add(LodePNGColorMode* info, + unsigned char r, unsigned char g, unsigned char b, unsigned char a) { + unsigned char* data; + /*the same resize technique as C++ std::vectors is used, and here it's made so that for a palette with + the max of 256 colors, it'll have the exact alloc size*/ + if(!info->palette) /*allocate palette if empty*/ { + /*room for 256 colors with 4 bytes each*/ + data = (unsigned char*)lodepng_realloc(info->palette, 1024); + if(!data) return 83; /*alloc fail*/ + else info->palette = data; + } + info->palette[4 * info->palettesize + 0] = r; + info->palette[4 * info->palettesize + 1] = g; + info->palette[4 * info->palettesize + 2] = b; + info->palette[4 * info->palettesize + 3] = a; + ++info->palettesize; + return 0; +} + +/*calculate bits per pixel out of colortype and bitdepth*/ +unsigned lodepng_get_bpp(const LodePNGColorMode* info) { + return lodepng_get_bpp_lct(info->colortype, info->bitdepth); +} + +unsigned lodepng_get_channels(const LodePNGColorMode* info) { + return getNumColorChannels(info->colortype); +} + +unsigned lodepng_is_greyscale_type(const LodePNGColorMode* info) { + return info->colortype == LCT_GREY || info->colortype == LCT_GREY_ALPHA; +} + +unsigned lodepng_is_alpha_type(const LodePNGColorMode* info) { + return (info->colortype & 4) != 0; /*4 or 6*/ +} + +unsigned lodepng_is_palette_type(const LodePNGColorMode* info) { + return info->colortype == LCT_PALETTE; +} + +unsigned lodepng_has_palette_alpha(const LodePNGColorMode* info) { + size_t i; + for(i = 0; i != info->palettesize; ++i) { + if(info->palette[i * 4 + 3] < 255) return 1; + } + return 0; +} + +unsigned lodepng_can_have_alpha(const LodePNGColorMode* info) { + return info->key_defined + || lodepng_is_alpha_type(info) + || lodepng_has_palette_alpha(info); +} + +size_t lodepng_get_raw_size_lct(unsigned w, unsigned h, LodePNGColorType colortype, unsigned bitdepth) { + size_t bpp = lodepng_get_bpp_lct(colortype, bitdepth); + size_t n = (size_t)w * (size_t)h; + return ((n / 8) * bpp) + ((n & 7) * bpp + 7) / 8; +} + +size_t lodepng_get_raw_size(unsigned w, unsigned h, const LodePNGColorMode* color) { + return lodepng_get_raw_size_lct(w, h, color->colortype, color->bitdepth); +} + + +#ifdef LODEPNG_COMPILE_PNG +#ifdef LODEPNG_COMPILE_DECODER + +/*in an idat chunk, each scanline is a multiple of 8 bits, unlike the lodepng output buffer, +and in addition has one extra byte per line: the filter byte. So this gives a larger +result than lodepng_get_raw_size. */ +static size_t lodepng_get_raw_size_idat(unsigned w, unsigned h, const LodePNGColorMode* color) { + size_t bpp = lodepng_get_bpp(color); + /* + 1 for the filter byte, and possibly plus padding bits per line */ + size_t line = ((size_t)(w / 8) * bpp) + 1 + ((w & 7) * bpp + 7) / 8; + return (size_t)h * line; +} + +/* Safely check if multiplying two integers will overflow (no undefined +behavior, compiler removing the code, etc...) and output result. */ +static int lodepng_mulofl(size_t a, size_t b, size_t* result) { + *result = a * b; /* Unsigned multiplication is well defined and safe in C90 */ + return (a != 0 && *result / a != b); +} + +/* Safely check if adding two integers will overflow (no undefined +behavior, compiler removing the code, etc...) and output result. */ +static int lodepng_addofl(size_t a, size_t b, size_t* result) { + *result = a + b; /* Unsigned addition is well defined and safe in C90 */ + return *result < a; +} + +/*Safely checks whether size_t overflow can be caused due to amount of pixels. +This check is overcautious rather than precise. If this check indicates no overflow, +you can safely compute in a size_t (but not an unsigned): +-(size_t)w * (size_t)h * 8 +-amount of bytes in IDAT (including filter, padding and Adam7 bytes) +-amount of bytes in raw color model +Returns 1 if overflow possible, 0 if not. +*/ +static int lodepng_pixel_overflow(unsigned w, unsigned h, + const LodePNGColorMode* pngcolor, const LodePNGColorMode* rawcolor) { + size_t bpp = LODEPNG_MAX(lodepng_get_bpp(pngcolor), lodepng_get_bpp(rawcolor)); + size_t numpixels, total; + size_t line; /* bytes per line in worst case */ + + if(lodepng_mulofl((size_t)w, (size_t)h, &numpixels)) return 1; + if(lodepng_mulofl(numpixels, 8, &total)) return 1; /* bit pointer with 8-bit color, or 8 bytes per channel color */ + + /* Bytes per scanline with the expression "(w / 8) * bpp) + ((w & 7) * bpp + 7) / 8" */ + if(lodepng_mulofl((size_t)(w / 8), bpp, &line)) return 1; + if(lodepng_addofl(line, ((w & 7) * bpp + 7) / 8, &line)) return 1; + + if(lodepng_addofl(line, 5, &line)) return 1; /* 5 bytes overhead per line: 1 filterbyte, 4 for Adam7 worst case */ + if(lodepng_mulofl(line, h, &total)) return 1; /* Total bytes in worst case */ + + return 0; /* no overflow */ +} +#endif /*LODEPNG_COMPILE_DECODER*/ +#endif /*LODEPNG_COMPILE_PNG*/ + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + +static void LodePNGUnknownChunks_init(LodePNGInfo* info) { + unsigned i; + for(i = 0; i != 3; ++i) info->unknown_chunks_data[i] = 0; + for(i = 0; i != 3; ++i) info->unknown_chunks_size[i] = 0; +} + +static void LodePNGUnknownChunks_cleanup(LodePNGInfo* info) { + unsigned i; + for(i = 0; i != 3; ++i) lodepng_free(info->unknown_chunks_data[i]); +} + +static unsigned LodePNGUnknownChunks_copy(LodePNGInfo* dest, const LodePNGInfo* src) { + unsigned i; + + LodePNGUnknownChunks_cleanup(dest); + + for(i = 0; i != 3; ++i) { + size_t j; + dest->unknown_chunks_size[i] = src->unknown_chunks_size[i]; + dest->unknown_chunks_data[i] = (unsigned char*)lodepng_malloc(src->unknown_chunks_size[i]); + if(!dest->unknown_chunks_data[i] && dest->unknown_chunks_size[i]) return 83; /*alloc fail*/ + for(j = 0; j < src->unknown_chunks_size[i]; ++j) { + dest->unknown_chunks_data[i][j] = src->unknown_chunks_data[i][j]; + } + } + + return 0; +} + +/******************************************************************************/ + +static void LodePNGText_init(LodePNGInfo* info) { + info->text_num = 0; + info->text_keys = NULL; + info->text_strings = NULL; +} + +static void LodePNGText_cleanup(LodePNGInfo* info) { + size_t i; + for(i = 0; i != info->text_num; ++i) { + string_cleanup(&info->text_keys[i]); + string_cleanup(&info->text_strings[i]); + } + lodepng_free(info->text_keys); + lodepng_free(info->text_strings); +} + +static unsigned LodePNGText_copy(LodePNGInfo* dest, const LodePNGInfo* source) { + size_t i = 0; + dest->text_keys = 0; + dest->text_strings = 0; + dest->text_num = 0; + for(i = 0; i != source->text_num; ++i) { + CERROR_TRY_RETURN(lodepng_add_text(dest, source->text_keys[i], source->text_strings[i])); + } + return 0; +} + +void lodepng_clear_text(LodePNGInfo* info) { + LodePNGText_cleanup(info); +} + +unsigned lodepng_add_text(LodePNGInfo* info, const char* key, const char* str) { + char** new_keys = (char**)(lodepng_realloc(info->text_keys, sizeof(char*) * (info->text_num + 1))); + char** new_strings = (char**)(lodepng_realloc(info->text_strings, sizeof(char*) * (info->text_num + 1))); + if(!new_keys || !new_strings) { + lodepng_free(new_keys); + lodepng_free(new_strings); + return 83; /*alloc fail*/ + } + + ++info->text_num; + info->text_keys = new_keys; + info->text_strings = new_strings; + + info->text_keys[info->text_num - 1] = alloc_string(key); + info->text_strings[info->text_num - 1] = alloc_string(str); + + return 0; +} + +/******************************************************************************/ + +static void LodePNGIText_init(LodePNGInfo* info) { + info->itext_num = 0; + info->itext_keys = NULL; + info->itext_langtags = NULL; + info->itext_transkeys = NULL; + info->itext_strings = NULL; +} + +static void LodePNGIText_cleanup(LodePNGInfo* info) { + size_t i; + for(i = 0; i != info->itext_num; ++i) { + string_cleanup(&info->itext_keys[i]); + string_cleanup(&info->itext_langtags[i]); + string_cleanup(&info->itext_transkeys[i]); + string_cleanup(&info->itext_strings[i]); + } + lodepng_free(info->itext_keys); + lodepng_free(info->itext_langtags); + lodepng_free(info->itext_transkeys); + lodepng_free(info->itext_strings); +} + +static unsigned LodePNGIText_copy(LodePNGInfo* dest, const LodePNGInfo* source) { + size_t i = 0; + dest->itext_keys = 0; + dest->itext_langtags = 0; + dest->itext_transkeys = 0; + dest->itext_strings = 0; + dest->itext_num = 0; + for(i = 0; i != source->itext_num; ++i) { + CERROR_TRY_RETURN(lodepng_add_itext(dest, source->itext_keys[i], source->itext_langtags[i], + source->itext_transkeys[i], source->itext_strings[i])); + } + return 0; +} + +void lodepng_clear_itext(LodePNGInfo* info) { + LodePNGIText_cleanup(info); +} + +unsigned lodepng_add_itext(LodePNGInfo* info, const char* key, const char* langtag, + const char* transkey, const char* str) { + char** new_keys = (char**)(lodepng_realloc(info->itext_keys, sizeof(char*) * (info->itext_num + 1))); + char** new_langtags = (char**)(lodepng_realloc(info->itext_langtags, sizeof(char*) * (info->itext_num + 1))); + char** new_transkeys = (char**)(lodepng_realloc(info->itext_transkeys, sizeof(char*) * (info->itext_num + 1))); + char** new_strings = (char**)(lodepng_realloc(info->itext_strings, sizeof(char*) * (info->itext_num + 1))); + if(!new_keys || !new_langtags || !new_transkeys || !new_strings) { + lodepng_free(new_keys); + lodepng_free(new_langtags); + lodepng_free(new_transkeys); + lodepng_free(new_strings); + return 83; /*alloc fail*/ + } + + ++info->itext_num; + info->itext_keys = new_keys; + info->itext_langtags = new_langtags; + info->itext_transkeys = new_transkeys; + info->itext_strings = new_strings; + + info->itext_keys[info->itext_num - 1] = alloc_string(key); + info->itext_langtags[info->itext_num - 1] = alloc_string(langtag); + info->itext_transkeys[info->itext_num - 1] = alloc_string(transkey); + info->itext_strings[info->itext_num - 1] = alloc_string(str); + + return 0; +} + +/* same as set but does not delete */ +static unsigned lodepng_assign_icc(LodePNGInfo* info, const char* name, const unsigned char* profile, unsigned profile_size) { + info->iccp_name = alloc_string(name); + info->iccp_profile = (unsigned char*)lodepng_malloc(profile_size); + + if(!info->iccp_name || !info->iccp_profile) return 83; /*alloc fail*/ + + memcpy(info->iccp_profile, profile, profile_size); + info->iccp_profile_size = profile_size; + + return 0; /*ok*/ +} + +unsigned lodepng_set_icc(LodePNGInfo* info, const char* name, const unsigned char* profile, unsigned profile_size) { + if(info->iccp_name) lodepng_clear_icc(info); + info->iccp_defined = 1; + + return lodepng_assign_icc(info, name, profile, profile_size); +} + +void lodepng_clear_icc(LodePNGInfo* info) { + string_cleanup(&info->iccp_name); + lodepng_free(info->iccp_profile); + info->iccp_profile = NULL; + info->iccp_profile_size = 0; + info->iccp_defined = 0; +} +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + +void lodepng_info_init(LodePNGInfo* info) { + lodepng_color_mode_init(&info->color); + info->interlace_method = 0; + info->compression_method = 0; + info->filter_method = 0; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + info->background_defined = 0; + info->background_r = info->background_g = info->background_b = 0; + + LodePNGText_init(info); + LodePNGIText_init(info); + + info->time_defined = 0; + info->phys_defined = 0; + + info->gama_defined = 0; + info->chrm_defined = 0; + info->srgb_defined = 0; + info->iccp_defined = 0; + info->iccp_name = NULL; + info->iccp_profile = NULL; + + LodePNGUnknownChunks_init(info); +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ +} + +void lodepng_info_cleanup(LodePNGInfo* info) { + lodepng_color_mode_cleanup(&info->color); +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + LodePNGText_cleanup(info); + LodePNGIText_cleanup(info); + + lodepng_clear_icc(info); + + LodePNGUnknownChunks_cleanup(info); +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ +} + +unsigned lodepng_info_copy(LodePNGInfo* dest, const LodePNGInfo* source) { + lodepng_info_cleanup(dest); + *dest = *source; + lodepng_color_mode_init(&dest->color); + CERROR_TRY_RETURN(lodepng_color_mode_copy(&dest->color, &source->color)); + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + CERROR_TRY_RETURN(LodePNGText_copy(dest, source)); + CERROR_TRY_RETURN(LodePNGIText_copy(dest, source)); + if(source->iccp_defined) { + CERROR_TRY_RETURN(lodepng_assign_icc(dest, source->iccp_name, source->iccp_profile, source->iccp_profile_size)); + } + + LodePNGUnknownChunks_init(dest); + CERROR_TRY_RETURN(LodePNGUnknownChunks_copy(dest, source)); +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + return 0; +} + +/* ////////////////////////////////////////////////////////////////////////// */ + +/*index: bitgroup index, bits: bitgroup size(1, 2 or 4), in: bitgroup value, out: octet array to add bits to*/ +static void addColorBits(unsigned char* out, size_t index, unsigned bits, unsigned in) { + unsigned m = bits == 1 ? 7 : bits == 2 ? 3 : 1; /*8 / bits - 1*/ + /*p = the partial index in the byte, e.g. with 4 palettebits it is 0 for first half or 1 for second half*/ + unsigned p = index & m; + in &= (1u << bits) - 1u; /*filter out any other bits of the input value*/ + in = in << (bits * (m - p)); + if(p == 0) out[index * bits / 8] = in; + else out[index * bits / 8] |= in; +} + +typedef struct ColorTree ColorTree; + +/* +One node of a color tree +This is the data structure used to count the number of unique colors and to get a palette +index for a color. It's like an octree, but because the alpha channel is used too, each +node has 16 instead of 8 children. +*/ +struct ColorTree { + ColorTree* children[16]; /*up to 16 pointers to ColorTree of next level*/ + int index; /*the payload. Only has a meaningful value if this is in the last level*/ +}; + +static void color_tree_init(ColorTree* tree) { + int i; + for(i = 0; i != 16; ++i) tree->children[i] = 0; + tree->index = -1; +} + +static void color_tree_cleanup(ColorTree* tree) { + int i; + for(i = 0; i != 16; ++i) { + if(tree->children[i]) { + color_tree_cleanup(tree->children[i]); + lodepng_free(tree->children[i]); + } + } +} + +/*returns -1 if color not present, its index otherwise*/ +static int color_tree_get(ColorTree* tree, unsigned char r, unsigned char g, unsigned char b, unsigned char a) { + int bit = 0; + for(bit = 0; bit < 8; ++bit) { + int i = 8 * ((r >> bit) & 1) + 4 * ((g >> bit) & 1) + 2 * ((b >> bit) & 1) + 1 * ((a >> bit) & 1); + if(!tree->children[i]) return -1; + else tree = tree->children[i]; + } + return tree ? tree->index : -1; +} + +#ifdef LODEPNG_COMPILE_ENCODER +static int color_tree_has(ColorTree* tree, unsigned char r, unsigned char g, unsigned char b, unsigned char a) { + return color_tree_get(tree, r, g, b, a) >= 0; +} +#endif /*LODEPNG_COMPILE_ENCODER*/ + +/*color is not allowed to already exist. +Index should be >= 0 (it's signed to be compatible with using -1 for "doesn't exist")*/ +static void color_tree_add(ColorTree* tree, + unsigned char r, unsigned char g, unsigned char b, unsigned char a, unsigned index) { + int bit; + for(bit = 0; bit < 8; ++bit) { + int i = 8 * ((r >> bit) & 1) + 4 * ((g >> bit) & 1) + 2 * ((b >> bit) & 1) + 1 * ((a >> bit) & 1); + if(!tree->children[i]) { + tree->children[i] = (ColorTree*)lodepng_malloc(sizeof(ColorTree)); + color_tree_init(tree->children[i]); + } + tree = tree->children[i]; + } + tree->index = (int)index; +} + +/*put a pixel, given its RGBA color, into image of any color type*/ +static unsigned rgba8ToPixel(unsigned char* out, size_t i, + const LodePNGColorMode* mode, ColorTree* tree /*for palette*/, + unsigned char r, unsigned char g, unsigned char b, unsigned char a) { + if(mode->colortype == LCT_GREY) { + unsigned char gray = r; /*((unsigned short)r + g + b) / 3;*/ + if(mode->bitdepth == 8) out[i] = gray; + else if(mode->bitdepth == 16) out[i * 2 + 0] = out[i * 2 + 1] = gray; + else { + /*take the most significant bits of gray*/ + gray = (gray >> (8 - mode->bitdepth)) & ((1 << mode->bitdepth) - 1); + addColorBits(out, i, mode->bitdepth, gray); + } + } else if(mode->colortype == LCT_RGB) { + if(mode->bitdepth == 8) { + out[i * 3 + 0] = r; + out[i * 3 + 1] = g; + out[i * 3 + 2] = b; + } else { + out[i * 6 + 0] = out[i * 6 + 1] = r; + out[i * 6 + 2] = out[i * 6 + 3] = g; + out[i * 6 + 4] = out[i * 6 + 5] = b; + } + } else if(mode->colortype == LCT_PALETTE) { + int index = color_tree_get(tree, r, g, b, a); + if(index < 0) return 82; /*color not in palette*/ + if(mode->bitdepth == 8) out[i] = index; + else addColorBits(out, i, mode->bitdepth, (unsigned)index); + } else if(mode->colortype == LCT_GREY_ALPHA) { + unsigned char gray = r; /*((unsigned short)r + g + b) / 3;*/ + if(mode->bitdepth == 8) { + out[i * 2 + 0] = gray; + out[i * 2 + 1] = a; + } else if(mode->bitdepth == 16) { + out[i * 4 + 0] = out[i * 4 + 1] = gray; + out[i * 4 + 2] = out[i * 4 + 3] = a; + } + } else if(mode->colortype == LCT_RGBA) { + if(mode->bitdepth == 8) { + out[i * 4 + 0] = r; + out[i * 4 + 1] = g; + out[i * 4 + 2] = b; + out[i * 4 + 3] = a; + } else { + out[i * 8 + 0] = out[i * 8 + 1] = r; + out[i * 8 + 2] = out[i * 8 + 3] = g; + out[i * 8 + 4] = out[i * 8 + 5] = b; + out[i * 8 + 6] = out[i * 8 + 7] = a; + } + } + + return 0; /*no error*/ +} + +/*put a pixel, given its RGBA16 color, into image of any color 16-bitdepth type*/ +static void rgba16ToPixel(unsigned char* out, size_t i, + const LodePNGColorMode* mode, + unsigned short r, unsigned short g, unsigned short b, unsigned short a) { + if(mode->colortype == LCT_GREY) { + unsigned short gray = r; /*((unsigned)r + g + b) / 3;*/ + out[i * 2 + 0] = (gray >> 8) & 255; + out[i * 2 + 1] = gray & 255; + } else if(mode->colortype == LCT_RGB) { + out[i * 6 + 0] = (r >> 8) & 255; + out[i * 6 + 1] = r & 255; + out[i * 6 + 2] = (g >> 8) & 255; + out[i * 6 + 3] = g & 255; + out[i * 6 + 4] = (b >> 8) & 255; + out[i * 6 + 5] = b & 255; + } else if(mode->colortype == LCT_GREY_ALPHA) { + unsigned short gray = r; /*((unsigned)r + g + b) / 3;*/ + out[i * 4 + 0] = (gray >> 8) & 255; + out[i * 4 + 1] = gray & 255; + out[i * 4 + 2] = (a >> 8) & 255; + out[i * 4 + 3] = a & 255; + } else if(mode->colortype == LCT_RGBA) { + out[i * 8 + 0] = (r >> 8) & 255; + out[i * 8 + 1] = r & 255; + out[i * 8 + 2] = (g >> 8) & 255; + out[i * 8 + 3] = g & 255; + out[i * 8 + 4] = (b >> 8) & 255; + out[i * 8 + 5] = b & 255; + out[i * 8 + 6] = (a >> 8) & 255; + out[i * 8 + 7] = a & 255; + } +} + +/*Get RGBA8 color of pixel with index i (y * width + x) from the raw image with given color type.*/ +static void getPixelColorRGBA8(unsigned char* r, unsigned char* g, + unsigned char* b, unsigned char* a, + const unsigned char* in, size_t i, + const LodePNGColorMode* mode) { + if(mode->colortype == LCT_GREY) { + if(mode->bitdepth == 8) { + *r = *g = *b = in[i]; + if(mode->key_defined && *r == mode->key_r) *a = 0; + else *a = 255; + } else if(mode->bitdepth == 16) { + *r = *g = *b = in[i * 2 + 0]; + if(mode->key_defined && 256U * in[i * 2 + 0] + in[i * 2 + 1] == mode->key_r) *a = 0; + else *a = 255; + } else { + unsigned highest = ((1U << mode->bitdepth) - 1U); /*highest possible value for this bit depth*/ + size_t j = i * mode->bitdepth; + unsigned value = readBitsFromReversedStream(&j, in, mode->bitdepth); + *r = *g = *b = (value * 255) / highest; + if(mode->key_defined && value == mode->key_r) *a = 0; + else *a = 255; + } + } else if(mode->colortype == LCT_RGB) { + if(mode->bitdepth == 8) { + *r = in[i * 3 + 0]; *g = in[i * 3 + 1]; *b = in[i * 3 + 2]; + if(mode->key_defined && *r == mode->key_r && *g == mode->key_g && *b == mode->key_b) *a = 0; + else *a = 255; + } else { + *r = in[i * 6 + 0]; + *g = in[i * 6 + 2]; + *b = in[i * 6 + 4]; + if(mode->key_defined && 256U * in[i * 6 + 0] + in[i * 6 + 1] == mode->key_r + && 256U * in[i * 6 + 2] + in[i * 6 + 3] == mode->key_g + && 256U * in[i * 6 + 4] + in[i * 6 + 5] == mode->key_b) *a = 0; + else *a = 255; + } + } else if(mode->colortype == LCT_PALETTE) { + unsigned index; + if(mode->bitdepth == 8) index = in[i]; + else { + size_t j = i * mode->bitdepth; + index = readBitsFromReversedStream(&j, in, mode->bitdepth); + } + + if(index >= mode->palettesize) { + /*This is an error according to the PNG spec, but common PNG decoders make it black instead. + Done here too, slightly faster due to no error handling needed.*/ + *r = *g = *b = 0; + *a = 255; + } else { + *r = mode->palette[index * 4 + 0]; + *g = mode->palette[index * 4 + 1]; + *b = mode->palette[index * 4 + 2]; + *a = mode->palette[index * 4 + 3]; + } + } else if(mode->colortype == LCT_GREY_ALPHA) { + if(mode->bitdepth == 8) { + *r = *g = *b = in[i * 2 + 0]; + *a = in[i * 2 + 1]; + } else { + *r = *g = *b = in[i * 4 + 0]; + *a = in[i * 4 + 2]; + } + } else if(mode->colortype == LCT_RGBA) { + if(mode->bitdepth == 8) { + *r = in[i * 4 + 0]; + *g = in[i * 4 + 1]; + *b = in[i * 4 + 2]; + *a = in[i * 4 + 3]; + } else { + *r = in[i * 8 + 0]; + *g = in[i * 8 + 2]; + *b = in[i * 8 + 4]; + *a = in[i * 8 + 6]; + } + } +} + +/*Similar to getPixelColorRGBA8, but with all the for loops inside of the color +mode test cases, optimized to convert the colors much faster, when converting +to RGBA or RGB with 8 bit per cannel. buffer must be RGBA or RGB output with +enough memory, if has_alpha is true the output is RGBA. mode has the color mode +of the input buffer.*/ +static void getPixelColorsRGBA8(unsigned char* buffer, size_t numpixels, + unsigned has_alpha, const unsigned char* in, + const LodePNGColorMode* mode) { + unsigned num_channels = has_alpha ? 4 : 3; + size_t i; + if(mode->colortype == LCT_GREY) { + if(mode->bitdepth == 8) { + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + buffer[0] = buffer[1] = buffer[2] = in[i]; + if(has_alpha) buffer[3] = mode->key_defined && in[i] == mode->key_r ? 0 : 255; + } + } else if(mode->bitdepth == 16) { + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + buffer[0] = buffer[1] = buffer[2] = in[i * 2]; + if(has_alpha) buffer[3] = mode->key_defined && 256U * in[i * 2 + 0] + in[i * 2 + 1] == mode->key_r ? 0 : 255; + } + } else { + unsigned highest = ((1U << mode->bitdepth) - 1U); /*highest possible value for this bit depth*/ + size_t j = 0; + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + unsigned value = readBitsFromReversedStream(&j, in, mode->bitdepth); + buffer[0] = buffer[1] = buffer[2] = (value * 255) / highest; + if(has_alpha) buffer[3] = mode->key_defined && value == mode->key_r ? 0 : 255; + } + } + } else if(mode->colortype == LCT_RGB) { + if(mode->bitdepth == 8) { + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + buffer[0] = in[i * 3 + 0]; + buffer[1] = in[i * 3 + 1]; + buffer[2] = in[i * 3 + 2]; + if(has_alpha) buffer[3] = mode->key_defined && buffer[0] == mode->key_r + && buffer[1]== mode->key_g && buffer[2] == mode->key_b ? 0 : 255; + } + } else { + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + buffer[0] = in[i * 6 + 0]; + buffer[1] = in[i * 6 + 2]; + buffer[2] = in[i * 6 + 4]; + if(has_alpha) buffer[3] = mode->key_defined + && 256U * in[i * 6 + 0] + in[i * 6 + 1] == mode->key_r + && 256U * in[i * 6 + 2] + in[i * 6 + 3] == mode->key_g + && 256U * in[i * 6 + 4] + in[i * 6 + 5] == mode->key_b ? 0 : 255; + } + } + } else if(mode->colortype == LCT_PALETTE) { + unsigned index; + size_t j = 0; + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + if(mode->bitdepth == 8) index = in[i]; + else index = readBitsFromReversedStream(&j, in, mode->bitdepth); + + if(index >= mode->palettesize) { + /*This is an error according to the PNG spec, but most PNG decoders make it black instead. + Done here too, slightly faster due to no error handling needed.*/ + buffer[0] = buffer[1] = buffer[2] = 0; + if(has_alpha) buffer[3] = 255; + } else { + buffer[0] = mode->palette[index * 4 + 0]; + buffer[1] = mode->palette[index * 4 + 1]; + buffer[2] = mode->palette[index * 4 + 2]; + if(has_alpha) buffer[3] = mode->palette[index * 4 + 3]; + } + } + } else if(mode->colortype == LCT_GREY_ALPHA) { + if(mode->bitdepth == 8) { + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + buffer[0] = buffer[1] = buffer[2] = in[i * 2 + 0]; + if(has_alpha) buffer[3] = in[i * 2 + 1]; + } + } else { + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + buffer[0] = buffer[1] = buffer[2] = in[i * 4 + 0]; + if(has_alpha) buffer[3] = in[i * 4 + 2]; + } + } + } else if(mode->colortype == LCT_RGBA) { + if(mode->bitdepth == 8) { + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + buffer[0] = in[i * 4 + 0]; + buffer[1] = in[i * 4 + 1]; + buffer[2] = in[i * 4 + 2]; + if(has_alpha) buffer[3] = in[i * 4 + 3]; + } + } else { + for(i = 0; i != numpixels; ++i, buffer += num_channels) { + buffer[0] = in[i * 8 + 0]; + buffer[1] = in[i * 8 + 2]; + buffer[2] = in[i * 8 + 4]; + if(has_alpha) buffer[3] = in[i * 8 + 6]; + } + } + } +} + +/*Get RGBA16 color of pixel with index i (y * width + x) from the raw image with +given color type, but the given color type must be 16-bit itself.*/ +static void getPixelColorRGBA16(unsigned short* r, unsigned short* g, unsigned short* b, unsigned short* a, + const unsigned char* in, size_t i, const LodePNGColorMode* mode) { + if(mode->colortype == LCT_GREY) { + *r = *g = *b = 256 * in[i * 2 + 0] + in[i * 2 + 1]; + if(mode->key_defined && 256U * in[i * 2 + 0] + in[i * 2 + 1] == mode->key_r) *a = 0; + else *a = 65535; + } else if(mode->colortype == LCT_RGB) { + *r = 256u * in[i * 6 + 0] + in[i * 6 + 1]; + *g = 256u * in[i * 6 + 2] + in[i * 6 + 3]; + *b = 256u * in[i * 6 + 4] + in[i * 6 + 5]; + if(mode->key_defined + && 256u * in[i * 6 + 0] + in[i * 6 + 1] == mode->key_r + && 256u * in[i * 6 + 2] + in[i * 6 + 3] == mode->key_g + && 256u * in[i * 6 + 4] + in[i * 6 + 5] == mode->key_b) *a = 0; + else *a = 65535; + } else if(mode->colortype == LCT_GREY_ALPHA) { + *r = *g = *b = 256u * in[i * 4 + 0] + in[i * 4 + 1]; + *a = 256u * in[i * 4 + 2] + in[i * 4 + 3]; + } else if(mode->colortype == LCT_RGBA) { + *r = 256u * in[i * 8 + 0] + in[i * 8 + 1]; + *g = 256u * in[i * 8 + 2] + in[i * 8 + 3]; + *b = 256u * in[i * 8 + 4] + in[i * 8 + 5]; + *a = 256u * in[i * 8 + 6] + in[i * 8 + 7]; + } +} + +unsigned lodepng_convert(unsigned char* out, const unsigned char* in, + const LodePNGColorMode* mode_out, const LodePNGColorMode* mode_in, + unsigned w, unsigned h) { + size_t i; + ColorTree tree; + size_t numpixels = (size_t)w * (size_t)h; + unsigned error = 0; + + if(lodepng_color_mode_equal(mode_out, mode_in)) { + size_t numbytes = lodepng_get_raw_size(w, h, mode_in); + for(i = 0; i != numbytes; ++i) out[i] = in[i]; + return 0; + } + + if(mode_out->colortype == LCT_PALETTE) { + size_t palettesize = mode_out->palettesize; + const unsigned char* palette = mode_out->palette; + size_t palsize = (size_t)1u << mode_out->bitdepth; + /*if the user specified output palette but did not give the values, assume + they want the values of the input color type (assuming that one is palette). + Note that we never create a new palette ourselves.*/ + if(palettesize == 0) { + palettesize = mode_in->palettesize; + palette = mode_in->palette; + /*if the input was also palette with same bitdepth, then the color types are also + equal, so copy literally. This to preserve the exact indices that were in the PNG + even in case there are duplicate colors in the palette.*/ + if (mode_in->colortype == LCT_PALETTE && mode_in->bitdepth == mode_out->bitdepth) { + size_t numbytes = lodepng_get_raw_size(w, h, mode_in); + for(i = 0; i != numbytes; ++i) out[i] = in[i]; + return 0; + } + } + if(palettesize < palsize) palsize = palettesize; + color_tree_init(&tree); + for(i = 0; i != palsize; ++i) { + const unsigned char* p = &palette[i * 4]; + color_tree_add(&tree, p[0], p[1], p[2], p[3], (unsigned)i); + } + } + + if(mode_in->bitdepth == 16 && mode_out->bitdepth == 16) { + for(i = 0; i != numpixels; ++i) { + unsigned short r = 0, g = 0, b = 0, a = 0; + getPixelColorRGBA16(&r, &g, &b, &a, in, i, mode_in); + rgba16ToPixel(out, i, mode_out, r, g, b, a); + } + } else if(mode_out->bitdepth == 8 && mode_out->colortype == LCT_RGBA) { + getPixelColorsRGBA8(out, numpixels, 1, in, mode_in); + } else if(mode_out->bitdepth == 8 && mode_out->colortype == LCT_RGB) { + getPixelColorsRGBA8(out, numpixels, 0, in, mode_in); + } else { + unsigned char r = 0, g = 0, b = 0, a = 0; + for(i = 0; i != numpixels; ++i) { + getPixelColorRGBA8(&r, &g, &b, &a, in, i, mode_in); + error = rgba8ToPixel(out, i, mode_out, &tree, r, g, b, a); + if (error) break; + } + } + + if(mode_out->colortype == LCT_PALETTE) { + color_tree_cleanup(&tree); + } + + return error; +} + + +/* Converts a single rgb color without alpha from one type to another, color bits truncated to +their bitdepth. In case of single channel (gray or palette), only the r channel is used. Slow +function, do not use to process all pixels of an image. Alpha channel not supported on purpose: +this is for bKGD, supporting alpha may prevent it from finding a color in the palette, from the +specification it looks like bKGD should ignore the alpha values of the palette since it can use +any palette index but doesn't have an alpha channel. Idem with ignoring color key. */ +unsigned lodepng_convert_rgb( + unsigned* r_out, unsigned* g_out, unsigned* b_out, + unsigned r_in, unsigned g_in, unsigned b_in, + const LodePNGColorMode* mode_out, const LodePNGColorMode* mode_in) { + unsigned r = 0, g = 0, b = 0; + unsigned mul = 65535 / ((1u << mode_in->bitdepth) - 1u); /*65535, 21845, 4369, 257, 1*/ + unsigned shift = 16 - mode_out->bitdepth; + + if(mode_in->colortype == LCT_GREY || mode_in->colortype == LCT_GREY_ALPHA) { + r = g = b = r_in * mul; + } else if(mode_in->colortype == LCT_RGB || mode_in->colortype == LCT_RGBA) { + r = r_in * mul; + g = g_in * mul; + b = b_in * mul; + } else if(mode_in->colortype == LCT_PALETTE) { + if(r_in >= mode_in->palettesize) return 82; + r = mode_in->palette[r_in * 4 + 0] * 257u; + g = mode_in->palette[r_in * 4 + 1] * 257u; + b = mode_in->palette[r_in * 4 + 2] * 257u; + } else { + return 31; + } + + /* now convert to output format */ + if(mode_out->colortype == LCT_GREY || mode_out->colortype == LCT_GREY_ALPHA) { + *r_out = r >> shift ; + } else if(mode_out->colortype == LCT_RGB || mode_out->colortype == LCT_RGBA) { + *r_out = r >> shift ; + *g_out = g >> shift ; + *b_out = b >> shift ; + } else if(mode_out->colortype == LCT_PALETTE) { + unsigned i; + /* a 16-bit color cannot be in the palette */ + if((r >> 8) != (r & 255) || (g >> 8) != (g & 255) || (b >> 8) != (b & 255)) return 82; + for(i = 0; i < mode_out->palettesize; i++) { + unsigned j = i * 4; + if((r >> 8) == mode_out->palette[j + 0] && (g >> 8) == mode_out->palette[j + 1] && + (b >> 8) == mode_out->palette[j + 2]) { + *r_out = i; + return 0; + } + } + return 82; + } else { + return 31; + } + + return 0; +} + +#ifdef LODEPNG_COMPILE_ENCODER + +void lodepng_color_profile_init(LodePNGColorProfile* profile) { + profile->colored = 0; + profile->key = 0; + profile->key_r = profile->key_g = profile->key_b = 0; + profile->alpha = 0; + profile->numcolors = 0; + profile->bits = 1; + profile->numpixels = 0; +} + +/*function used for debug purposes with C++*/ +/*void printColorProfile(LodePNGColorProfile* p) { + std::cout << "colored: " << (int)p->colored << ", "; + std::cout << "key: " << (int)p->key << ", "; + std::cout << "key_r: " << (int)p->key_r << ", "; + std::cout << "key_g: " << (int)p->key_g << ", "; + std::cout << "key_b: " << (int)p->key_b << ", "; + std::cout << "alpha: " << (int)p->alpha << ", "; + std::cout << "numcolors: " << (int)p->numcolors << ", "; + std::cout << "bits: " << (int)p->bits << std::endl; +}*/ + +/*Returns how many bits needed to represent given value (max 8 bit)*/ +static unsigned getValueRequiredBits(unsigned char value) { + if(value == 0 || value == 255) return 1; + /*The scaling of 2-bit and 4-bit values uses multiples of 85 and 17*/ + if(value % 17 == 0) return value % 85 == 0 ? 2 : 4; + return 8; +} + +/*profile must already have been inited. +It's ok to set some parameters of profile to done already.*/ +unsigned lodepng_get_color_profile(LodePNGColorProfile* profile, + const unsigned char* in, unsigned w, unsigned h, + const LodePNGColorMode* mode_in) { + unsigned error = 0; + size_t i; + ColorTree tree; + size_t numpixels = (size_t)w * (size_t)h; + + /* mark things as done already if it would be impossible to have a more expensive case */ + unsigned colored_done = lodepng_is_greyscale_type(mode_in) ? 1 : 0; + unsigned alpha_done = lodepng_can_have_alpha(mode_in) ? 0 : 1; + unsigned numcolors_done = 0; + unsigned bpp = lodepng_get_bpp(mode_in); + unsigned bits_done = (profile->bits == 1 && bpp == 1) ? 1 : 0; + unsigned sixteen = 0; /* whether the input image is 16 bit */ + unsigned maxnumcolors = 257; + if(bpp <= 8) maxnumcolors = LODEPNG_MIN(257, profile->numcolors + (1u << bpp)); + + profile->numpixels += numpixels; + + color_tree_init(&tree); + + /*If the profile was already filled in from previous data, fill its palette in tree + and mark things as done already if we know they are the most expensive case already*/ + if(profile->alpha) alpha_done = 1; + if(profile->colored) colored_done = 1; + if(profile->bits == 16) numcolors_done = 1; + if(profile->bits >= bpp) bits_done = 1; + if(profile->numcolors >= maxnumcolors) numcolors_done = 1; + + if(!numcolors_done) { + for(i = 0; i < profile->numcolors; i++) { + const unsigned char* color = &profile->palette[i * 4]; + color_tree_add(&tree, color[0], color[1], color[2], color[3], i); + } + } + + /*Check if the 16-bit input is truly 16-bit*/ + if(mode_in->bitdepth == 16 && !sixteen) { + unsigned short r, g, b, a; + for(i = 0; i != numpixels; ++i) { + getPixelColorRGBA16(&r, &g, &b, &a, in, i, mode_in); + if((r & 255) != ((r >> 8) & 255) || (g & 255) != ((g >> 8) & 255) || + (b & 255) != ((b >> 8) & 255) || (a & 255) != ((a >> 8) & 255)) /*first and second byte differ*/ { + profile->bits = 16; + sixteen = 1; + bits_done = 1; + numcolors_done = 1; /*counting colors no longer useful, palette doesn't support 16-bit*/ + break; + } + } + } + + if(sixteen) { + unsigned short r = 0, g = 0, b = 0, a = 0; + + for(i = 0; i != numpixels; ++i) { + getPixelColorRGBA16(&r, &g, &b, &a, in, i, mode_in); + + if(!colored_done && (r != g || r != b)) { + profile->colored = 1; + colored_done = 1; + } + + if(!alpha_done) { + unsigned matchkey = (r == profile->key_r && g == profile->key_g && b == profile->key_b); + if(a != 65535 && (a != 0 || (profile->key && !matchkey))) { + profile->alpha = 1; + profile->key = 0; + alpha_done = 1; + } else if(a == 0 && !profile->alpha && !profile->key) { + profile->key = 1; + profile->key_r = r; + profile->key_g = g; + profile->key_b = b; + } else if(a == 65535 && profile->key && matchkey) { + /* Color key cannot be used if an opaque pixel also has that RGB color. */ + profile->alpha = 1; + profile->key = 0; + alpha_done = 1; + } + } + if(alpha_done && numcolors_done && colored_done && bits_done) break; + } + + if(profile->key && !profile->alpha) { + for(i = 0; i != numpixels; ++i) { + getPixelColorRGBA16(&r, &g, &b, &a, in, i, mode_in); + if(a != 0 && r == profile->key_r && g == profile->key_g && b == profile->key_b) { + /* Color key cannot be used if an opaque pixel also has that RGB color. */ + profile->alpha = 1; + profile->key = 0; + alpha_done = 1; + } + } + } + } else /* < 16-bit */ { + unsigned char r = 0, g = 0, b = 0, a = 0; + for(i = 0; i != numpixels; ++i) { + getPixelColorRGBA8(&r, &g, &b, &a, in, i, mode_in); + + if(!bits_done && profile->bits < 8) { + /*only r is checked, < 8 bits is only relevant for grayscale*/ + unsigned bits = getValueRequiredBits(r); + if(bits > profile->bits) profile->bits = bits; + } + bits_done = (profile->bits >= bpp); + + if(!colored_done && (r != g || r != b)) { + profile->colored = 1; + colored_done = 1; + if(profile->bits < 8) profile->bits = 8; /*PNG has no colored modes with less than 8-bit per channel*/ + } + + if(!alpha_done) { + unsigned matchkey = (r == profile->key_r && g == profile->key_g && b == profile->key_b); + if(a != 255 && (a != 0 || (profile->key && !matchkey))) { + profile->alpha = 1; + profile->key = 0; + alpha_done = 1; + if(profile->bits < 8) profile->bits = 8; /*PNG has no alphachannel modes with less than 8-bit per channel*/ + } else if(a == 0 && !profile->alpha && !profile->key) { + profile->key = 1; + profile->key_r = r; + profile->key_g = g; + profile->key_b = b; + } else if(a == 255 && profile->key && matchkey) { + /* Color key cannot be used if an opaque pixel also has that RGB color. */ + profile->alpha = 1; + profile->key = 0; + alpha_done = 1; + if(profile->bits < 8) profile->bits = 8; /*PNG has no alphachannel modes with less than 8-bit per channel*/ + } + } + + if(!numcolors_done) { + if(!color_tree_has(&tree, r, g, b, a)) { + color_tree_add(&tree, r, g, b, a, profile->numcolors); + if(profile->numcolors < 256) { + unsigned char* p = profile->palette; + unsigned n = profile->numcolors; + p[n * 4 + 0] = r; + p[n * 4 + 1] = g; + p[n * 4 + 2] = b; + p[n * 4 + 3] = a; + } + ++profile->numcolors; + numcolors_done = profile->numcolors >= maxnumcolors; + } + } + + if(alpha_done && numcolors_done && colored_done && bits_done) break; + } + + if(profile->key && !profile->alpha) { + for(i = 0; i != numpixels; ++i) { + getPixelColorRGBA8(&r, &g, &b, &a, in, i, mode_in); + if(a != 0 && r == profile->key_r && g == profile->key_g && b == profile->key_b) { + /* Color key cannot be used if an opaque pixel also has that RGB color. */ + profile->alpha = 1; + profile->key = 0; + alpha_done = 1; + if(profile->bits < 8) profile->bits = 8; /*PNG has no alphachannel modes with less than 8-bit per channel*/ + } + } + } + + /*make the profile's key always 16-bit for consistency - repeat each byte twice*/ + profile->key_r += (profile->key_r << 8); + profile->key_g += (profile->key_g << 8); + profile->key_b += (profile->key_b << 8); + } + + color_tree_cleanup(&tree); + return error; +} + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS +/*Adds a single color to the color profile. The profile must already have been inited. The color must be given as 16-bit +(with 2 bytes repeating for 8-bit and 65535 for opaque alpha channel). This function is expensive, do not call it for +all pixels of an image but only for a few additional values. */ +static unsigned lodepng_color_profile_add(LodePNGColorProfile* profile, + unsigned r, unsigned g, unsigned b, unsigned a) { + unsigned error = 0; + unsigned char image[8]; + LodePNGColorMode mode; + lodepng_color_mode_init(&mode); + image[0] = r >> 8; image[1] = r; image[2] = g >> 8; image[3] = g; + image[4] = b >> 8; image[5] = b; image[6] = a >> 8; image[7] = a; + mode.bitdepth = 16; + mode.colortype = LCT_RGBA; + error = lodepng_get_color_profile(profile, image, 1, 1, &mode); + lodepng_color_mode_cleanup(&mode); + return error; +} +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + +/*Autochoose color model given the computed profile. mode_in is to copy palette order from +when relevant.*/ +static unsigned auto_choose_color_from_profile(LodePNGColorMode* mode_out, + const LodePNGColorMode* mode_in, + const LodePNGColorProfile* prof) { + unsigned error = 0; + unsigned palettebits, palette_ok; + size_t i, n; + size_t numpixels = prof->numpixels; + + unsigned alpha = prof->alpha; + unsigned key = prof->key; + unsigned bits = prof->bits; + + mode_out->key_defined = 0; + + if(key && numpixels <= 16) { + alpha = 1; /*too few pixels to justify tRNS chunk overhead*/ + key = 0; + if(bits < 8) bits = 8; /*PNG has no alphachannel modes with less than 8-bit per channel*/ + } + n = prof->numcolors; + palettebits = n <= 2 ? 1 : (n <= 4 ? 2 : (n <= 16 ? 4 : 8)); + palette_ok = n <= 256 && bits <= 8; + if(numpixels < n * 2) palette_ok = 0; /*don't add palette overhead if image has only a few pixels*/ + if(!prof->colored && bits <= palettebits) palette_ok = 0; /*gray is less overhead*/ + + if(palette_ok) { + const unsigned char* p = prof->palette; + lodepng_palette_clear(mode_out); /*remove potential earlier palette*/ + for(i = 0; i != prof->numcolors; ++i) { + error = lodepng_palette_add(mode_out, p[i * 4 + 0], p[i * 4 + 1], p[i * 4 + 2], p[i * 4 + 3]); + if(error) break; + } + + mode_out->colortype = LCT_PALETTE; + mode_out->bitdepth = palettebits; + + if(mode_in->colortype == LCT_PALETTE && mode_in->palettesize >= mode_out->palettesize + && mode_in->bitdepth == mode_out->bitdepth) { + /*If input should have same palette colors, keep original to preserve its order and prevent conversion*/ + lodepng_color_mode_cleanup(mode_out); + lodepng_color_mode_copy(mode_out, mode_in); + } + } else /*8-bit or 16-bit per channel*/ { + mode_out->bitdepth = bits; + mode_out->colortype = alpha ? (prof->colored ? LCT_RGBA : LCT_GREY_ALPHA) + : (prof->colored ? LCT_RGB : LCT_GREY); + + if(key) { + unsigned mask = (1u << mode_out->bitdepth) - 1u; /*profile always uses 16-bit, mask converts it*/ + mode_out->key_r = prof->key_r & mask; + mode_out->key_g = prof->key_g & mask; + mode_out->key_b = prof->key_b & mask; + mode_out->key_defined = 1; + } + } + + return error; +} + +/*Automatically chooses color type that gives smallest amount of bits in the +output image, e.g. gray if there are only grayscale pixels, palette if there +are less than 256 colors, color key if only single transparent color, ... +Updates values of mode with a potentially smaller color model. mode_out should +contain the user chosen color model, but will be overwritten with the new chosen one.*/ +unsigned lodepng_auto_choose_color(LodePNGColorMode* mode_out, + const unsigned char* image, unsigned w, unsigned h, + const LodePNGColorMode* mode_in) { + unsigned error = 0; + LodePNGColorProfile prof; + lodepng_color_profile_init(&prof); + error = lodepng_get_color_profile(&prof, image, w, h, mode_in); + if(error) return error; + return auto_choose_color_from_profile(mode_out, mode_in, &prof); +} + +#endif /* #ifdef LODEPNG_COMPILE_ENCODER */ + +/* +Paeth predicter, used by PNG filter type 4 +The parameters are of type short, but should come from unsigned chars, the shorts +are only needed to make the paeth calculation correct. +*/ +static unsigned char paethPredictor(short a, short b, short c) { + short pa = abs(b - c); + short pb = abs(a - c); + short pc = abs(a + b - c - c); + + if(pc < pa && pc < pb) return (unsigned char)c; + else if(pb < pa) return (unsigned char)b; + else return (unsigned char)a; +} + +/*shared values used by multiple Adam7 related functions*/ + +static const unsigned ADAM7_IX[7] = { 0, 4, 0, 2, 0, 1, 0 }; /*x start values*/ +static const unsigned ADAM7_IY[7] = { 0, 0, 4, 0, 2, 0, 1 }; /*y start values*/ +static const unsigned ADAM7_DX[7] = { 8, 8, 4, 4, 2, 2, 1 }; /*x delta values*/ +static const unsigned ADAM7_DY[7] = { 8, 8, 8, 4, 4, 2, 2 }; /*y delta values*/ + +/* +Outputs various dimensions and positions in the image related to the Adam7 reduced images. +passw: output containing the width of the 7 passes +passh: output containing the height of the 7 passes +filter_passstart: output containing the index of the start and end of each + reduced image with filter bytes +padded_passstart output containing the index of the start and end of each + reduced image when without filter bytes but with padded scanlines +passstart: output containing the index of the start and end of each reduced + image without padding between scanlines, but still padding between the images +w, h: width and height of non-interlaced image +bpp: bits per pixel +"padded" is only relevant if bpp is less than 8 and a scanline or image does not + end at a full byte +*/ +static void Adam7_getpassvalues(unsigned passw[7], unsigned passh[7], size_t filter_passstart[8], + size_t padded_passstart[8], size_t passstart[8], unsigned w, unsigned h, unsigned bpp) { + /*the passstart values have 8 values: the 8th one indicates the byte after the end of the 7th (= last) pass*/ + unsigned i; + + /*calculate width and height in pixels of each pass*/ + for(i = 0; i != 7; ++i) { + passw[i] = (w + ADAM7_DX[i] - ADAM7_IX[i] - 1) / ADAM7_DX[i]; + passh[i] = (h + ADAM7_DY[i] - ADAM7_IY[i] - 1) / ADAM7_DY[i]; + if(passw[i] == 0) passh[i] = 0; + if(passh[i] == 0) passw[i] = 0; + } + + filter_passstart[0] = padded_passstart[0] = passstart[0] = 0; + for(i = 0; i != 7; ++i) { + /*if passw[i] is 0, it's 0 bytes, not 1 (no filtertype-byte)*/ + filter_passstart[i + 1] = filter_passstart[i] + + ((passw[i] && passh[i]) ? passh[i] * (1 + (passw[i] * bpp + 7) / 8) : 0); + /*bits padded if needed to fill full byte at end of each scanline*/ + padded_passstart[i + 1] = padded_passstart[i] + passh[i] * ((passw[i] * bpp + 7) / 8); + /*only padded at end of reduced image*/ + passstart[i + 1] = passstart[i] + (passh[i] * passw[i] * bpp + 7) / 8; + } +} + +#ifdef LODEPNG_COMPILE_DECODER + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / PNG Decoder / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +/*read the information from the header and store it in the LodePNGInfo. return value is error*/ +unsigned lodepng_inspect(unsigned* w, unsigned* h, LodePNGState* state, + const unsigned char* in, size_t insize) { + unsigned width, height; + LodePNGInfo* info = &state->info_png; + if(insize == 0 || in == 0) { + CERROR_RETURN_ERROR(state->error, 48); /*error: the given data is empty*/ + } + if(insize < 33) { + CERROR_RETURN_ERROR(state->error, 27); /*error: the data length is smaller than the length of a PNG header*/ + } + + /*when decoding a new PNG image, make sure all parameters created after previous decoding are reset*/ + /* TODO: remove this. One should use a new LodePNGState for new sessions */ + lodepng_info_cleanup(info); + lodepng_info_init(info); + + if(in[0] != 137 || in[1] != 80 || in[2] != 78 || in[3] != 71 + || in[4] != 13 || in[5] != 10 || in[6] != 26 || in[7] != 10) { + CERROR_RETURN_ERROR(state->error, 28); /*error: the first 8 bytes are not the correct PNG signature*/ + } + if(lodepng_chunk_length(in + 8) != 13) { + CERROR_RETURN_ERROR(state->error, 94); /*error: header size must be 13 bytes*/ + } + if(!lodepng_chunk_type_equals(in + 8, "IHDR")) { + CERROR_RETURN_ERROR(state->error, 29); /*error: it doesn't start with a IHDR chunk!*/ + } + + /*read the values given in the header*/ + width = lodepng_read32bitInt(&in[16]); + height = lodepng_read32bitInt(&in[20]); + info->color.bitdepth = in[24]; + info->color.colortype = (LodePNGColorType)in[25]; + info->compression_method = in[26]; + info->filter_method = in[27]; + info->interlace_method = in[28]; + + if(width == 0 || height == 0) { + CERROR_RETURN_ERROR(state->error, 93); + } + + if(w) *w = width; + if(h) *h = height; + + if(!state->decoder.ignore_crc) { + unsigned CRC = lodepng_read32bitInt(&in[29]); + unsigned checksum = lodepng_crc32(&in[12], 17); + if(CRC != checksum) { + CERROR_RETURN_ERROR(state->error, 57); /*invalid CRC*/ + } + } + + /*error: only compression method 0 is allowed in the specification*/ + if(info->compression_method != 0) CERROR_RETURN_ERROR(state->error, 32); + /*error: only filter method 0 is allowed in the specification*/ + if(info->filter_method != 0) CERROR_RETURN_ERROR(state->error, 33); + /*error: only interlace methods 0 and 1 exist in the specification*/ + if(info->interlace_method > 1) CERROR_RETURN_ERROR(state->error, 34); + + state->error = checkColorValidity(info->color.colortype, info->color.bitdepth); + return state->error; +} + +static unsigned unfilterScanline(unsigned char* recon, const unsigned char* scanline, const unsigned char* precon, + size_t bytewidth, unsigned char filterType, size_t length) { + /* + For PNG filter method 0 + unfilter a PNG image scanline by scanline. when the pixels are smaller than 1 byte, + the filter works byte per byte (bytewidth = 1) + precon is the previous unfiltered scanline, recon the result, scanline the current one + the incoming scanlines do NOT include the filtertype byte, that one is given in the parameter filterType instead + recon and scanline MAY be the same memory address! precon must be disjoint. + */ + + size_t i; + switch(filterType) { + case 0: + for(i = 0; i != length; ++i) recon[i] = scanline[i]; + break; + case 1: + for(i = 0; i != bytewidth; ++i) recon[i] = scanline[i]; + for(i = bytewidth; i < length; ++i) recon[i] = scanline[i] + recon[i - bytewidth]; + break; + case 2: + if(precon) { + for(i = 0; i != length; ++i) recon[i] = scanline[i] + precon[i]; + } else { + for(i = 0; i != length; ++i) recon[i] = scanline[i]; + } + break; + case 3: + if(precon) { + for(i = 0; i != bytewidth; ++i) recon[i] = scanline[i] + (precon[i] >> 1); + for(i = bytewidth; i < length; ++i) recon[i] = scanline[i] + ((recon[i - bytewidth] + precon[i]) >> 1); + } else { + for(i = 0; i != bytewidth; ++i) recon[i] = scanline[i]; + for(i = bytewidth; i < length; ++i) recon[i] = scanline[i] + (recon[i - bytewidth] >> 1); + } + break; + case 4: + if(precon) { + for(i = 0; i != bytewidth; ++i) { + recon[i] = (scanline[i] + precon[i]); /*paethPredictor(0, precon[i], 0) is always precon[i]*/ + } + for(i = bytewidth; i < length; ++i) { + recon[i] = (scanline[i] + paethPredictor(recon[i - bytewidth], precon[i], precon[i - bytewidth])); + } + } else { + for(i = 0; i != bytewidth; ++i) { + recon[i] = scanline[i]; + } + for(i = bytewidth; i < length; ++i) { + /*paethPredictor(recon[i - bytewidth], 0, 0) is always recon[i - bytewidth]*/ + recon[i] = (scanline[i] + recon[i - bytewidth]); + } + } + break; + default: return 36; /*error: unexisting filter type given*/ + } + return 0; +} + +static unsigned unfilter(unsigned char* out, const unsigned char* in, unsigned w, unsigned h, unsigned bpp) { + /* + For PNG filter method 0 + this function unfilters a single image (e.g. without interlacing this is called once, with Adam7 seven times) + out must have enough bytes allocated already, in must have the scanlines + 1 filtertype byte per scanline + w and h are image dimensions or dimensions of reduced image, bpp is bits per pixel + in and out are allowed to be the same memory address (but aren't the same size since in has the extra filter bytes) + */ + + unsigned y; + unsigned char* prevline = 0; + + /*bytewidth is used for filtering, is 1 when bpp < 8, number of bytes per pixel otherwise*/ + size_t bytewidth = (bpp + 7) / 8; + size_t linebytes = (w * bpp + 7) / 8; + + for(y = 0; y < h; ++y) { + size_t outindex = linebytes * y; + size_t inindex = (1 + linebytes) * y; /*the extra filterbyte added to each row*/ + unsigned char filterType = in[inindex]; + + CERROR_TRY_RETURN(unfilterScanline(&out[outindex], &in[inindex + 1], prevline, bytewidth, filterType, linebytes)); + + prevline = &out[outindex]; + } + + return 0; +} + +/* +in: Adam7 interlaced image, with no padding bits between scanlines, but between + reduced images so that each reduced image starts at a byte. +out: the same pixels, but re-ordered so that they're now a non-interlaced image with size w*h +bpp: bits per pixel +out has the following size in bits: w * h * bpp. +in is possibly bigger due to padding bits between reduced images. +out must be big enough AND must be 0 everywhere if bpp < 8 in the current implementation +(because that's likely a little bit faster) +NOTE: comments about padding bits are only relevant if bpp < 8 +*/ +static void Adam7_deinterlace(unsigned char* out, const unsigned char* in, unsigned w, unsigned h, unsigned bpp) { + unsigned passw[7], passh[7]; + size_t filter_passstart[8], padded_passstart[8], passstart[8]; + unsigned i; + + Adam7_getpassvalues(passw, passh, filter_passstart, padded_passstart, passstart, w, h, bpp); + + if(bpp >= 8) { + for(i = 0; i != 7; ++i) { + unsigned x, y, b; + size_t bytewidth = bpp / 8; + for(y = 0; y < passh[i]; ++y) + for(x = 0; x < passw[i]; ++x) { + size_t pixelinstart = passstart[i] + (y * passw[i] + x) * bytewidth; + size_t pixeloutstart = ((ADAM7_IY[i] + y * ADAM7_DY[i]) * w + ADAM7_IX[i] + x * ADAM7_DX[i]) * bytewidth; + for(b = 0; b < bytewidth; ++b) { + out[pixeloutstart + b] = in[pixelinstart + b]; + } + } + } + } else /*bpp < 8: Adam7 with pixels < 8 bit is a bit trickier: with bit pointers*/ { + for(i = 0; i != 7; ++i) { + unsigned x, y, b; + unsigned ilinebits = bpp * passw[i]; + unsigned olinebits = bpp * w; + size_t obp, ibp; /*bit pointers (for out and in buffer)*/ + for(y = 0; y < passh[i]; ++y) + for(x = 0; x < passw[i]; ++x) { + ibp = (8 * passstart[i]) + (y * ilinebits + x * bpp); + obp = (ADAM7_IY[i] + y * ADAM7_DY[i]) * olinebits + (ADAM7_IX[i] + x * ADAM7_DX[i]) * bpp; + for(b = 0; b < bpp; ++b) { + unsigned char bit = readBitFromReversedStream(&ibp, in); + /*note that this function assumes the out buffer is completely 0, use setBitOfReversedStream otherwise*/ + setBitOfReversedStream0(&obp, out, bit); + } + } + } + } +} + +static void removePaddingBits(unsigned char* out, const unsigned char* in, + size_t olinebits, size_t ilinebits, unsigned h) { + /* + After filtering there are still padding bits if scanlines have non multiple of 8 bit amounts. They need + to be removed (except at last scanline of (Adam7-reduced) image) before working with pure image buffers + for the Adam7 code, the color convert code and the output to the user. + in and out are allowed to be the same buffer, in may also be higher but still overlapping; in must + have >= ilinebits*h bits, out must have >= olinebits*h bits, olinebits must be <= ilinebits + also used to move bits after earlier such operations happened, e.g. in a sequence of reduced images from Adam7 + only useful if (ilinebits - olinebits) is a value in the range 1..7 + */ + unsigned y; + size_t diff = ilinebits - olinebits; + size_t ibp = 0, obp = 0; /*input and output bit pointers*/ + for(y = 0; y < h; ++y) { + size_t x; + for(x = 0; x < olinebits; ++x) { + unsigned char bit = readBitFromReversedStream(&ibp, in); + setBitOfReversedStream(&obp, out, bit); + } + ibp += diff; + } +} + +/*out must be buffer big enough to contain full image, and in must contain the full decompressed data from +the IDAT chunks (with filter index bytes and possible padding bits) +return value is error*/ +static unsigned postProcessScanlines(unsigned char* out, unsigned char* in, + unsigned w, unsigned h, const LodePNGInfo* info_png) { + /* + This function converts the filtered-padded-interlaced data into pure 2D image buffer with the PNG's colortype. + Steps: + *) if no Adam7: 1) unfilter 2) remove padding bits (= posible extra bits per scanline if bpp < 8) + *) if adam7: 1) 7x unfilter 2) 7x remove padding bits 3) Adam7_deinterlace + NOTE: the in buffer will be overwritten with intermediate data! + */ + unsigned bpp = lodepng_get_bpp(&info_png->color); + if(bpp == 0) return 31; /*error: invalid colortype*/ + + if(info_png->interlace_method == 0) { + if(bpp < 8 && w * bpp != ((w * bpp + 7) / 8) * 8) { + CERROR_TRY_RETURN(unfilter(in, in, w, h, bpp)); + removePaddingBits(out, in, w * bpp, ((w * bpp + 7) / 8) * 8, h); + } + /*we can immediately filter into the out buffer, no other steps needed*/ + else CERROR_TRY_RETURN(unfilter(out, in, w, h, bpp)); + } else /*interlace_method is 1 (Adam7)*/ { + unsigned passw[7], passh[7]; size_t filter_passstart[8], padded_passstart[8], passstart[8]; + unsigned i; + + Adam7_getpassvalues(passw, passh, filter_passstart, padded_passstart, passstart, w, h, bpp); + + for(i = 0; i != 7; ++i) { + CERROR_TRY_RETURN(unfilter(&in[padded_passstart[i]], &in[filter_passstart[i]], passw[i], passh[i], bpp)); + /*TODO: possible efficiency improvement: if in this reduced image the bits fit nicely in 1 scanline, + move bytes instead of bits or move not at all*/ + if(bpp < 8) { + /*remove padding bits in scanlines; after this there still may be padding + bits between the different reduced images: each reduced image still starts nicely at a byte*/ + removePaddingBits(&in[passstart[i]], &in[padded_passstart[i]], passw[i] * bpp, + ((passw[i] * bpp + 7) / 8) * 8, passh[i]); + } + } + + Adam7_deinterlace(out, in, w, h, bpp); + } + + return 0; +} + +static unsigned readChunk_PLTE(LodePNGColorMode* color, const unsigned char* data, size_t chunkLength) { + unsigned pos = 0, i; + if(color->palette) lodepng_free(color->palette); + color->palettesize = chunkLength / 3; + color->palette = (unsigned char*)lodepng_malloc(4 * color->palettesize); + if(!color->palette && color->palettesize) { + color->palettesize = 0; + return 83; /*alloc fail*/ + } + if(color->palettesize > 256) return 38; /*error: palette too big*/ + + for(i = 0; i != color->palettesize; ++i) { + color->palette[4 * i + 0] = data[pos++]; /*R*/ + color->palette[4 * i + 1] = data[pos++]; /*G*/ + color->palette[4 * i + 2] = data[pos++]; /*B*/ + color->palette[4 * i + 3] = 255; /*alpha*/ + } + + return 0; /* OK */ +} + +static unsigned readChunk_tRNS(LodePNGColorMode* color, const unsigned char* data, size_t chunkLength) { + unsigned i; + if(color->colortype == LCT_PALETTE) { + /*error: more alpha values given than there are palette entries*/ + if(chunkLength > color->palettesize) return 39; + + for(i = 0; i != chunkLength; ++i) color->palette[4 * i + 3] = data[i]; + } else if(color->colortype == LCT_GREY) { + /*error: this chunk must be 2 bytes for grayscale image*/ + if(chunkLength != 2) return 30; + + color->key_defined = 1; + color->key_r = color->key_g = color->key_b = 256u * data[0] + data[1]; + } else if(color->colortype == LCT_RGB) { + /*error: this chunk must be 6 bytes for RGB image*/ + if(chunkLength != 6) return 41; + + color->key_defined = 1; + color->key_r = 256u * data[0] + data[1]; + color->key_g = 256u * data[2] + data[3]; + color->key_b = 256u * data[4] + data[5]; + } + else return 42; /*error: tRNS chunk not allowed for other color models*/ + + return 0; /* OK */ +} + + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS +/*background color chunk (bKGD)*/ +static unsigned readChunk_bKGD(LodePNGInfo* info, const unsigned char* data, size_t chunkLength) { + if(info->color.colortype == LCT_PALETTE) { + /*error: this chunk must be 1 byte for indexed color image*/ + if(chunkLength != 1) return 43; + + /*error: invalid palette index, or maybe this chunk appeared before PLTE*/ + if(data[0] >= info->color.palettesize) return 103; + + info->background_defined = 1; + info->background_r = info->background_g = info->background_b = data[0]; + } else if(info->color.colortype == LCT_GREY || info->color.colortype == LCT_GREY_ALPHA) { + /*error: this chunk must be 2 bytes for grayscale image*/ + if(chunkLength != 2) return 44; + + /*the values are truncated to bitdepth in the PNG file*/ + info->background_defined = 1; + info->background_r = info->background_g = info->background_b = 256u * data[0] + data[1]; + } else if(info->color.colortype == LCT_RGB || info->color.colortype == LCT_RGBA) { + /*error: this chunk must be 6 bytes for grayscale image*/ + if(chunkLength != 6) return 45; + + /*the values are truncated to bitdepth in the PNG file*/ + info->background_defined = 1; + info->background_r = 256u * data[0] + data[1]; + info->background_g = 256u * data[2] + data[3]; + info->background_b = 256u * data[4] + data[5]; + } + + return 0; /* OK */ +} + +/*text chunk (tEXt)*/ +static unsigned readChunk_tEXt(LodePNGInfo* info, const unsigned char* data, size_t chunkLength) { + unsigned error = 0; + char *key = 0, *str = 0; + unsigned i; + + while(!error) /*not really a while loop, only used to break on error*/ { + unsigned length, string2_begin; + + length = 0; + while(length < chunkLength && data[length] != 0) ++length; + /*even though it's not allowed by the standard, no error is thrown if + there's no null termination char, if the text is empty*/ + if(length < 1 || length > 79) CERROR_BREAK(error, 89); /*keyword too short or long*/ + + key = (char*)lodepng_malloc(length + 1); + if(!key) CERROR_BREAK(error, 83); /*alloc fail*/ + + key[length] = 0; + for(i = 0; i != length; ++i) key[i] = (char)data[i]; + + string2_begin = length + 1; /*skip keyword null terminator*/ + + length = (unsigned)(chunkLength < string2_begin ? 0 : chunkLength - string2_begin); + str = (char*)lodepng_malloc(length + 1); + if(!str) CERROR_BREAK(error, 83); /*alloc fail*/ + + str[length] = 0; + for(i = 0; i != length; ++i) str[i] = (char)data[string2_begin + i]; + + error = lodepng_add_text(info, key, str); + + break; + } + + lodepng_free(key); + lodepng_free(str); + + return error; +} + +/*compressed text chunk (zTXt)*/ +static unsigned readChunk_zTXt(LodePNGInfo* info, const LodePNGDecompressSettings* zlibsettings, + const unsigned char* data, size_t chunkLength) { + unsigned error = 0; + unsigned i; + + unsigned length, string2_begin; + char *key = 0; + ucvector decoded; + + ucvector_init(&decoded); + + while(!error) /*not really a while loop, only used to break on error*/ { + for(length = 0; length < chunkLength && data[length] != 0; ++length) ; + if(length + 2 >= chunkLength) CERROR_BREAK(error, 75); /*no null termination, corrupt?*/ + if(length < 1 || length > 79) CERROR_BREAK(error, 89); /*keyword too short or long*/ + + key = (char*)lodepng_malloc(length + 1); + if(!key) CERROR_BREAK(error, 83); /*alloc fail*/ + + key[length] = 0; + for(i = 0; i != length; ++i) key[i] = (char)data[i]; + + if(data[length + 1] != 0) CERROR_BREAK(error, 72); /*the 0 byte indicating compression must be 0*/ + + string2_begin = length + 2; + if(string2_begin > chunkLength) CERROR_BREAK(error, 75); /*no null termination, corrupt?*/ + + length = (unsigned)chunkLength - string2_begin; + /*will fail if zlib error, e.g. if length is too small*/ + error = zlib_decompress(&decoded.data, &decoded.size, + (unsigned char*)(&data[string2_begin]), + length, zlibsettings); + if(error) break; + ucvector_push_back(&decoded, 0); + + error = lodepng_add_text(info, key, (char*)decoded.data); + + break; + } + + lodepng_free(key); + ucvector_cleanup(&decoded); + + return error; +} + +/*international text chunk (iTXt)*/ +static unsigned readChunk_iTXt(LodePNGInfo* info, const LodePNGDecompressSettings* zlibsettings, + const unsigned char* data, size_t chunkLength) { + unsigned error = 0; + unsigned i; + + unsigned length, begin, compressed; + char *key = 0, *langtag = 0, *transkey = 0; + ucvector decoded; + ucvector_init(&decoded); /* TODO: only use in case of compressed text */ + + while(!error) /*not really a while loop, only used to break on error*/ { + /*Quick check if the chunk length isn't too small. Even without check + it'd still fail with other error checks below if it's too short. This just gives a different error code.*/ + if(chunkLength < 5) CERROR_BREAK(error, 30); /*iTXt chunk too short*/ + + /*read the key*/ + for(length = 0; length < chunkLength && data[length] != 0; ++length) ; + if(length + 3 >= chunkLength) CERROR_BREAK(error, 75); /*no null termination char, corrupt?*/ + if(length < 1 || length > 79) CERROR_BREAK(error, 89); /*keyword too short or long*/ + + key = (char*)lodepng_malloc(length + 1); + if(!key) CERROR_BREAK(error, 83); /*alloc fail*/ + + key[length] = 0; + for(i = 0; i != length; ++i) key[i] = (char)data[i]; + + /*read the compression method*/ + compressed = data[length + 1]; + if(data[length + 2] != 0) CERROR_BREAK(error, 72); /*the 0 byte indicating compression must be 0*/ + + /*even though it's not allowed by the standard, no error is thrown if + there's no null termination char, if the text is empty for the next 3 texts*/ + + /*read the langtag*/ + begin = length + 3; + length = 0; + for(i = begin; i < chunkLength && data[i] != 0; ++i) ++length; + + langtag = (char*)lodepng_malloc(length + 1); + if(!langtag) CERROR_BREAK(error, 83); /*alloc fail*/ + + langtag[length] = 0; + for(i = 0; i != length; ++i) langtag[i] = (char)data[begin + i]; + + /*read the transkey*/ + begin += length + 1; + length = 0; + for(i = begin; i < chunkLength && data[i] != 0; ++i) ++length; + + transkey = (char*)lodepng_malloc(length + 1); + if(!transkey) CERROR_BREAK(error, 83); /*alloc fail*/ + + transkey[length] = 0; + for(i = 0; i != length; ++i) transkey[i] = (char)data[begin + i]; + + /*read the actual text*/ + begin += length + 1; + + length = (unsigned)chunkLength < begin ? 0 : (unsigned)chunkLength - begin; + + if(compressed) { + /*will fail if zlib error, e.g. if length is too small*/ + error = zlib_decompress(&decoded.data, &decoded.size, + (unsigned char*)(&data[begin]), + length, zlibsettings); + if(error) break; + if(decoded.allocsize < decoded.size) decoded.allocsize = decoded.size; + ucvector_push_back(&decoded, 0); + } else { + if(!ucvector_resize(&decoded, length + 1)) CERROR_BREAK(error, 83 /*alloc fail*/); + + decoded.data[length] = 0; + for(i = 0; i != length; ++i) decoded.data[i] = data[begin + i]; + } + + error = lodepng_add_itext(info, key, langtag, transkey, (char*)decoded.data); + + break; + } + + lodepng_free(key); + lodepng_free(langtag); + lodepng_free(transkey); + ucvector_cleanup(&decoded); + + return error; +} + +static unsigned readChunk_tIME(LodePNGInfo* info, const unsigned char* data, size_t chunkLength) { + if(chunkLength != 7) return 73; /*invalid tIME chunk size*/ + + info->time_defined = 1; + info->time.year = 256u * data[0] + data[1]; + info->time.month = data[2]; + info->time.day = data[3]; + info->time.hour = data[4]; + info->time.minute = data[5]; + info->time.second = data[6]; + + return 0; /* OK */ +} + +static unsigned readChunk_pHYs(LodePNGInfo* info, const unsigned char* data, size_t chunkLength) { + if(chunkLength != 9) return 74; /*invalid pHYs chunk size*/ + + info->phys_defined = 1; + info->phys_x = 16777216u * data[0] + 65536u * data[1] + 256u * data[2] + data[3]; + info->phys_y = 16777216u * data[4] + 65536u * data[5] + 256u * data[6] + data[7]; + info->phys_unit = data[8]; + + return 0; /* OK */ +} + +static unsigned readChunk_gAMA(LodePNGInfo* info, const unsigned char* data, size_t chunkLength) { + if(chunkLength != 4) return 96; /*invalid gAMA chunk size*/ + + info->gama_defined = 1; + info->gama_gamma = 16777216u * data[0] + 65536u * data[1] + 256u * data[2] + data[3]; + + return 0; /* OK */ +} + +static unsigned readChunk_cHRM(LodePNGInfo* info, const unsigned char* data, size_t chunkLength) { + if(chunkLength != 32) return 97; /*invalid cHRM chunk size*/ + + info->chrm_defined = 1; + info->chrm_white_x = 16777216u * data[ 0] + 65536u * data[ 1] + 256u * data[ 2] + data[ 3]; + info->chrm_white_y = 16777216u * data[ 4] + 65536u * data[ 5] + 256u * data[ 6] + data[ 7]; + info->chrm_red_x = 16777216u * data[ 8] + 65536u * data[ 9] + 256u * data[10] + data[11]; + info->chrm_red_y = 16777216u * data[12] + 65536u * data[13] + 256u * data[14] + data[15]; + info->chrm_green_x = 16777216u * data[16] + 65536u * data[17] + 256u * data[18] + data[19]; + info->chrm_green_y = 16777216u * data[20] + 65536u * data[21] + 256u * data[22] + data[23]; + info->chrm_blue_x = 16777216u * data[24] + 65536u * data[25] + 256u * data[26] + data[27]; + info->chrm_blue_y = 16777216u * data[28] + 65536u * data[29] + 256u * data[30] + data[31]; + + return 0; /* OK */ +} + +static unsigned readChunk_sRGB(LodePNGInfo* info, const unsigned char* data, size_t chunkLength) { + if(chunkLength != 1) return 98; /*invalid sRGB chunk size (this one is never ignored)*/ + + info->srgb_defined = 1; + info->srgb_intent = data[0]; + + return 0; /* OK */ +} + +static unsigned readChunk_iCCP(LodePNGInfo* info, const LodePNGDecompressSettings* zlibsettings, + const unsigned char* data, size_t chunkLength) { + unsigned error = 0; + unsigned i; + + unsigned length, string2_begin; + ucvector decoded; + + info->iccp_defined = 1; + if(info->iccp_name) lodepng_clear_icc(info); + + for(length = 0; length < chunkLength && data[length] != 0; ++length) ; + if(length + 2 >= chunkLength) return 75; /*no null termination, corrupt?*/ + if(length < 1 || length > 79) return 89; /*keyword too short or long*/ + + info->iccp_name = (char*)lodepng_malloc(length + 1); + if(!info->iccp_name) return 83; /*alloc fail*/ + + info->iccp_name[length] = 0; + for(i = 0; i != length; ++i) info->iccp_name[i] = (char)data[i]; + + if(data[length + 1] != 0) return 72; /*the 0 byte indicating compression must be 0*/ + + string2_begin = length + 2; + if(string2_begin > chunkLength) return 75; /*no null termination, corrupt?*/ + + length = (unsigned)chunkLength - string2_begin; + ucvector_init(&decoded); + error = zlib_decompress(&decoded.data, &decoded.size, + (unsigned char*)(&data[string2_begin]), + length, zlibsettings); + if(!error) { + info->iccp_profile_size = decoded.size; + info->iccp_profile = (unsigned char*)lodepng_malloc(decoded.size); + if(info->iccp_profile) { + memcpy(info->iccp_profile, decoded.data, decoded.size); + } else { + error = 83; /* alloc fail */ + } + } + ucvector_cleanup(&decoded); + return error; +} +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + +unsigned lodepng_inspect_chunk(LodePNGState* state, size_t pos, + const unsigned char* in, size_t insize) { + const unsigned char* chunk = in + pos; + unsigned chunkLength; + const unsigned char* data; + unsigned unhandled = 0; + unsigned error = 0; + + if (pos + 4 > insize) return 30; + chunkLength = lodepng_chunk_length(chunk); + if(chunkLength > 2147483647) return 63; + data = lodepng_chunk_data_const(chunk); + if(data + chunkLength + 4 > in + insize) return 30; + + if(lodepng_chunk_type_equals(chunk, "PLTE")) { + error = readChunk_PLTE(&state->info_png.color, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "tRNS")) { + error = readChunk_tRNS(&state->info_png.color, data, chunkLength); +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + } else if(lodepng_chunk_type_equals(chunk, "bKGD")) { + error = readChunk_bKGD(&state->info_png, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "tEXt")) { + error = readChunk_tEXt(&state->info_png, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "zTXt")) { + error = readChunk_zTXt(&state->info_png, &state->decoder.zlibsettings, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "iTXt")) { + error = readChunk_iTXt(&state->info_png, &state->decoder.zlibsettings, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "tIME")) { + error = readChunk_tIME(&state->info_png, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "pHYs")) { + error = readChunk_pHYs(&state->info_png, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "gAMA")) { + error = readChunk_gAMA(&state->info_png, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "cHRM")) { + error = readChunk_cHRM(&state->info_png, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "sRGB")) { + error = readChunk_sRGB(&state->info_png, data, chunkLength); + } else if(lodepng_chunk_type_equals(chunk, "iCCP")) { + error = readChunk_iCCP(&state->info_png, &state->decoder.zlibsettings, data, chunkLength); +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + } else { + /* unhandled chunk is ok (is not an error) */ + unhandled = 1; + } + + if(!error && !unhandled && !state->decoder.ignore_crc) { + if(lodepng_chunk_check_crc(chunk)) return 57; /*invalid CRC*/ + } + + return error; +} + +/*read a PNG, the result will be in the same color type as the PNG (hence "generic")*/ +static void decodeGeneric(unsigned char** out, unsigned* w, unsigned* h, + LodePNGState* state, + const unsigned char* in, size_t insize) { + unsigned char IEND = 0; + const unsigned char* chunk; + size_t i; + ucvector idat; /*the data from idat chunks*/ + ucvector scanlines; + size_t predict; + size_t outsize = 0; + + /*for unknown chunk order*/ + unsigned unknown = 0; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + unsigned critical_pos = 1; /*1 = after IHDR, 2 = after PLTE, 3 = after IDAT*/ +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + + + /* safe output values in case error happens */ + *out = 0; + *w = *h = 0; + + state->error = lodepng_inspect(w, h, state, in, insize); /*reads header and resets other parameters in state->info_png*/ + if(state->error) return; + + if(lodepng_pixel_overflow(*w, *h, &state->info_png.color, &state->info_raw)) { + CERROR_RETURN(state->error, 92); /*overflow possible due to amount of pixels*/ + } + + ucvector_init(&idat); + chunk = &in[33]; /*first byte of the first chunk after the header*/ + + /*loop through the chunks, ignoring unknown chunks and stopping at IEND chunk. + IDAT data is put at the start of the in buffer*/ + while(!IEND && !state->error) { + unsigned chunkLength; + const unsigned char* data; /*the data in the chunk*/ + + /*error: size of the in buffer too small to contain next chunk*/ + if((size_t)((chunk - in) + 12) > insize || chunk < in) { + if(state->decoder.ignore_end) break; /*other errors may still happen though*/ + CERROR_BREAK(state->error, 30); + } + + /*length of the data of the chunk, excluding the length bytes, chunk type and CRC bytes*/ + chunkLength = lodepng_chunk_length(chunk); + /*error: chunk length larger than the max PNG chunk size*/ + if(chunkLength > 2147483647) { + if(state->decoder.ignore_end) break; /*other errors may still happen though*/ + CERROR_BREAK(state->error, 63); + } + + if((size_t)((chunk - in) + chunkLength + 12) > insize || (chunk + chunkLength + 12) < in) { + CERROR_BREAK(state->error, 64); /*error: size of the in buffer too small to contain next chunk*/ + } + + data = lodepng_chunk_data_const(chunk); + + unknown = 0; + + /*IDAT chunk, containing compressed image data*/ + if(lodepng_chunk_type_equals(chunk, "IDAT")) { + size_t oldsize = idat.size; + size_t newsize; + if(lodepng_addofl(oldsize, chunkLength, &newsize)) CERROR_BREAK(state->error, 95); + if(!ucvector_resize(&idat, newsize)) CERROR_BREAK(state->error, 83 /*alloc fail*/); + for(i = 0; i != chunkLength; ++i) idat.data[oldsize + i] = data[i]; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + critical_pos = 3; +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + } else if(lodepng_chunk_type_equals(chunk, "IEND")) { + /*IEND chunk*/ + IEND = 1; + } else if(lodepng_chunk_type_equals(chunk, "PLTE")) { + /*palette chunk (PLTE)*/ + state->error = readChunk_PLTE(&state->info_png.color, data, chunkLength); + if(state->error) break; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + critical_pos = 2; +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + } else if(lodepng_chunk_type_equals(chunk, "tRNS")) { + /*palette transparency chunk (tRNS). Even though this one is an ancillary chunk , it is still compiled + in without 'LODEPNG_COMPILE_ANCILLARY_CHUNKS' because it contains essential color information that + affects the alpha channel of pixels. */ + state->error = readChunk_tRNS(&state->info_png.color, data, chunkLength); + if(state->error) break; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + /*background color chunk (bKGD)*/ + } else if(lodepng_chunk_type_equals(chunk, "bKGD")) { + state->error = readChunk_bKGD(&state->info_png, data, chunkLength); + if(state->error) break; + } else if(lodepng_chunk_type_equals(chunk, "tEXt")) { + /*text chunk (tEXt)*/ + if(state->decoder.read_text_chunks) { + state->error = readChunk_tEXt(&state->info_png, data, chunkLength); + if(state->error) break; + } + } else if(lodepng_chunk_type_equals(chunk, "zTXt")) { + /*compressed text chunk (zTXt)*/ + if(state->decoder.read_text_chunks) { + state->error = readChunk_zTXt(&state->info_png, &state->decoder.zlibsettings, data, chunkLength); + if(state->error) break; + } + } else if(lodepng_chunk_type_equals(chunk, "iTXt")) { + /*international text chunk (iTXt)*/ + if(state->decoder.read_text_chunks) { + state->error = readChunk_iTXt(&state->info_png, &state->decoder.zlibsettings, data, chunkLength); + if(state->error) break; + } + } else if(lodepng_chunk_type_equals(chunk, "tIME")) { + state->error = readChunk_tIME(&state->info_png, data, chunkLength); + if(state->error) break; + } else if(lodepng_chunk_type_equals(chunk, "pHYs")) { + state->error = readChunk_pHYs(&state->info_png, data, chunkLength); + if(state->error) break; + } else if(lodepng_chunk_type_equals(chunk, "gAMA")) { + state->error = readChunk_gAMA(&state->info_png, data, chunkLength); + if(state->error) break; + } else if(lodepng_chunk_type_equals(chunk, "cHRM")) { + state->error = readChunk_cHRM(&state->info_png, data, chunkLength); + if(state->error) break; + } else if(lodepng_chunk_type_equals(chunk, "sRGB")) { + state->error = readChunk_sRGB(&state->info_png, data, chunkLength); + if(state->error) break; + } else if(lodepng_chunk_type_equals(chunk, "iCCP")) { + state->error = readChunk_iCCP(&state->info_png, &state->decoder.zlibsettings, data, chunkLength); + if(state->error) break; +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + } else /*it's not an implemented chunk type, so ignore it: skip over the data*/ { + /*error: unknown critical chunk (5th bit of first byte of chunk type is 0)*/ + if(!state->decoder.ignore_critical && !lodepng_chunk_ancillary(chunk)) { + CERROR_BREAK(state->error, 69); + } + + unknown = 1; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + if(state->decoder.remember_unknown_chunks) { + state->error = lodepng_chunk_append(&state->info_png.unknown_chunks_data[critical_pos - 1], + &state->info_png.unknown_chunks_size[critical_pos - 1], chunk); + if(state->error) break; + } +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + } + + if(!state->decoder.ignore_crc && !unknown) /*check CRC if wanted, only on known chunk types*/ { + if(lodepng_chunk_check_crc(chunk)) CERROR_BREAK(state->error, 57); /*invalid CRC*/ + } + + if(!IEND) chunk = lodepng_chunk_next_const(chunk); + } + + ucvector_init(&scanlines); + /*predict output size, to allocate exact size for output buffer to avoid more dynamic allocation. + If the decompressed size does not match the prediction, the image must be corrupt.*/ + if(state->info_png.interlace_method == 0) { + predict = lodepng_get_raw_size_idat(*w, *h, &state->info_png.color); + } else { + /*Adam-7 interlaced: predicted size is the sum of the 7 sub-images sizes*/ + const LodePNGColorMode* color = &state->info_png.color; + predict = 0; + predict += lodepng_get_raw_size_idat((*w + 7) >> 3, (*h + 7) >> 3, color); + if(*w > 4) predict += lodepng_get_raw_size_idat((*w + 3) >> 3, (*h + 7) >> 3, color); + predict += lodepng_get_raw_size_idat((*w + 3) >> 2, (*h + 3) >> 3, color); + if(*w > 2) predict += lodepng_get_raw_size_idat((*w + 1) >> 2, (*h + 3) >> 2, color); + predict += lodepng_get_raw_size_idat((*w + 1) >> 1, (*h + 1) >> 2, color); + if(*w > 1) predict += lodepng_get_raw_size_idat((*w + 0) >> 1, (*h + 1) >> 1, color); + predict += lodepng_get_raw_size_idat((*w + 0), (*h + 0) >> 1, color); + } + if(!state->error && !ucvector_reserve(&scanlines, predict)) state->error = 83; /*alloc fail*/ + if(!state->error) { + state->error = zlib_decompress(&scanlines.data, &scanlines.size, idat.data, + idat.size, &state->decoder.zlibsettings); + if(!state->error && scanlines.size != predict) state->error = 91; /*decompressed size doesn't match prediction*/ + } + ucvector_cleanup(&idat); + + if(!state->error) { + outsize = lodepng_get_raw_size(*w, *h, &state->info_png.color); + *out = (unsigned char*)lodepng_malloc(outsize); + if(!*out) state->error = 83; /*alloc fail*/ + } + if(!state->error) { + for(i = 0; i < outsize; i++) (*out)[i] = 0; + state->error = postProcessScanlines(*out, scanlines.data, *w, *h, &state->info_png); + } + ucvector_cleanup(&scanlines); +} + +unsigned lodepng_decode(unsigned char** out, unsigned* w, unsigned* h, + LodePNGState* state, + const unsigned char* in, size_t insize) { + *out = 0; + decodeGeneric(out, w, h, state, in, insize); + if(state->error) return state->error; + if(!state->decoder.color_convert || lodepng_color_mode_equal(&state->info_raw, &state->info_png.color)) { + /*same color type, no copying or converting of data needed*/ + /*store the info_png color settings on the info_raw so that the info_raw still reflects what colortype + the raw image has to the end user*/ + if(!state->decoder.color_convert) { + state->error = lodepng_color_mode_copy(&state->info_raw, &state->info_png.color); + if(state->error) return state->error; + } + } else { + /*color conversion needed; sort of copy of the data*/ + unsigned char* data = *out; + size_t outsize; + + /*TODO: check if this works according to the statement in the documentation: "The converter can convert + from grayscale input color type, to 8-bit grayscale or grayscale with alpha"*/ + if(!(state->info_raw.colortype == LCT_RGB || state->info_raw.colortype == LCT_RGBA) + && !(state->info_raw.bitdepth == 8)) { + return 56; /*unsupported color mode conversion*/ + } + + outsize = lodepng_get_raw_size(*w, *h, &state->info_raw); + *out = (unsigned char*)lodepng_malloc(outsize); + if(!(*out)) { + state->error = 83; /*alloc fail*/ + } + else state->error = lodepng_convert(*out, data, &state->info_raw, + &state->info_png.color, *w, *h); + lodepng_free(data); + } + return state->error; +} + +unsigned lodepng_decode_memory(unsigned char** out, unsigned* w, unsigned* h, const unsigned char* in, + size_t insize, LodePNGColorType colortype, unsigned bitdepth) { + unsigned error; + LodePNGState state; + lodepng_state_init(&state); + state.info_raw.colortype = colortype; + state.info_raw.bitdepth = bitdepth; + error = lodepng_decode(out, w, h, &state, in, insize); + lodepng_state_cleanup(&state); + return error; +} + +unsigned lodepng_decode32(unsigned char** out, unsigned* w, unsigned* h, const unsigned char* in, size_t insize) { + return lodepng_decode_memory(out, w, h, in, insize, LCT_RGBA, 8); +} + +unsigned lodepng_decode24(unsigned char** out, unsigned* w, unsigned* h, const unsigned char* in, size_t insize) { + return lodepng_decode_memory(out, w, h, in, insize, LCT_RGB, 8); +} + +#ifdef LODEPNG_COMPILE_DISK +unsigned lodepng_decode_file(unsigned char** out, unsigned* w, unsigned* h, const char* filename, + LodePNGColorType colortype, unsigned bitdepth) { + unsigned char* buffer = 0; + size_t buffersize; + unsigned error; + /* safe output values in case error happens */ + *out = 0; + *w = *h = 0; + error = lodepng_load_file(&buffer, &buffersize, filename); + if(!error) error = lodepng_decode_memory(out, w, h, buffer, buffersize, colortype, bitdepth); + lodepng_free(buffer); + return error; +} + +unsigned lodepng_decode32_file(unsigned char** out, unsigned* w, unsigned* h, const char* filename) { + return lodepng_decode_file(out, w, h, filename, LCT_RGBA, 8); +} + +unsigned lodepng_decode24_file(unsigned char** out, unsigned* w, unsigned* h, const char* filename) { + return lodepng_decode_file(out, w, h, filename, LCT_RGB, 8); +} +#endif /*LODEPNG_COMPILE_DISK*/ + +void lodepng_decoder_settings_init(LodePNGDecoderSettings* settings) { + settings->color_convert = 1; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + settings->read_text_chunks = 1; + settings->remember_unknown_chunks = 0; +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + settings->ignore_crc = 0; + settings->ignore_critical = 0; + settings->ignore_end = 0; + lodepng_decompress_settings_init(&settings->zlibsettings); +} + +#endif /*LODEPNG_COMPILE_DECODER*/ + +#if defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) + +void lodepng_state_init(LodePNGState* state) { +#ifdef LODEPNG_COMPILE_DECODER + lodepng_decoder_settings_init(&state->decoder); +#endif /*LODEPNG_COMPILE_DECODER*/ +#ifdef LODEPNG_COMPILE_ENCODER + lodepng_encoder_settings_init(&state->encoder); +#endif /*LODEPNG_COMPILE_ENCODER*/ + lodepng_color_mode_init(&state->info_raw); + lodepng_info_init(&state->info_png); + state->error = 1; +} + +void lodepng_state_cleanup(LodePNGState* state) { + lodepng_color_mode_cleanup(&state->info_raw); + lodepng_info_cleanup(&state->info_png); +} + +void lodepng_state_copy(LodePNGState* dest, const LodePNGState* source) { + lodepng_state_cleanup(dest); + *dest = *source; + lodepng_color_mode_init(&dest->info_raw); + lodepng_info_init(&dest->info_png); + dest->error = lodepng_color_mode_copy(&dest->info_raw, &source->info_raw); if(dest->error) return; + dest->error = lodepng_info_copy(&dest->info_png, &source->info_png); if(dest->error) return; +} + +#endif /* defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) */ + +#ifdef LODEPNG_COMPILE_ENCODER + +/* ////////////////////////////////////////////////////////////////////////// */ +/* / PNG Encoder / */ +/* ////////////////////////////////////////////////////////////////////////// */ + +/*chunkName must be string of 4 characters*/ +static unsigned addChunk(ucvector* out, const char* chunkName, const unsigned char* data, size_t length) { + CERROR_TRY_RETURN(lodepng_chunk_create(&out->data, &out->size, (unsigned)length, chunkName, data)); + out->allocsize = out->size; /*fix the allocsize again*/ + return 0; +} + +static void writeSignature(ucvector* out) { + /*8 bytes PNG signature, aka the magic bytes*/ + ucvector_push_back(out, 137); + ucvector_push_back(out, 80); + ucvector_push_back(out, 78); + ucvector_push_back(out, 71); + ucvector_push_back(out, 13); + ucvector_push_back(out, 10); + ucvector_push_back(out, 26); + ucvector_push_back(out, 10); +} + +static unsigned addChunk_IHDR(ucvector* out, unsigned w, unsigned h, + LodePNGColorType colortype, unsigned bitdepth, unsigned interlace_method) { + unsigned error = 0; + ucvector header; + ucvector_init(&header); + + lodepng_add32bitInt(&header, w); /*width*/ + lodepng_add32bitInt(&header, h); /*height*/ + ucvector_push_back(&header, (unsigned char)bitdepth); /*bit depth*/ + ucvector_push_back(&header, (unsigned char)colortype); /*color type*/ + ucvector_push_back(&header, 0); /*compression method*/ + ucvector_push_back(&header, 0); /*filter method*/ + ucvector_push_back(&header, interlace_method); /*interlace method*/ + + error = addChunk(out, "IHDR", header.data, header.size); + ucvector_cleanup(&header); + + return error; +} + +static unsigned addChunk_PLTE(ucvector* out, const LodePNGColorMode* info) { + unsigned error = 0; + size_t i; + ucvector PLTE; + ucvector_init(&PLTE); + for(i = 0; i != info->palettesize * 4; ++i) { + /*add all channels except alpha channel*/ + if(i % 4 != 3) ucvector_push_back(&PLTE, info->palette[i]); + } + error = addChunk(out, "PLTE", PLTE.data, PLTE.size); + ucvector_cleanup(&PLTE); + + return error; +} + +static unsigned addChunk_tRNS(ucvector* out, const LodePNGColorMode* info) { + unsigned error = 0; + size_t i; + ucvector tRNS; + ucvector_init(&tRNS); + if(info->colortype == LCT_PALETTE) { + size_t amount = info->palettesize; + /*the tail of palette values that all have 255 as alpha, does not have to be encoded*/ + for(i = info->palettesize; i != 0; --i) { + if(info->palette[4 * (i - 1) + 3] == 255) --amount; + else break; + } + /*add only alpha channel*/ + for(i = 0; i != amount; ++i) ucvector_push_back(&tRNS, info->palette[4 * i + 3]); + } else if(info->colortype == LCT_GREY) { + if(info->key_defined) { + ucvector_push_back(&tRNS, (unsigned char)(info->key_r >> 8)); + ucvector_push_back(&tRNS, (unsigned char)(info->key_r & 255)); + } + } else if(info->colortype == LCT_RGB) { + if(info->key_defined) { + ucvector_push_back(&tRNS, (unsigned char)(info->key_r >> 8)); + ucvector_push_back(&tRNS, (unsigned char)(info->key_r & 255)); + ucvector_push_back(&tRNS, (unsigned char)(info->key_g >> 8)); + ucvector_push_back(&tRNS, (unsigned char)(info->key_g & 255)); + ucvector_push_back(&tRNS, (unsigned char)(info->key_b >> 8)); + ucvector_push_back(&tRNS, (unsigned char)(info->key_b & 255)); + } + } + + error = addChunk(out, "tRNS", tRNS.data, tRNS.size); + ucvector_cleanup(&tRNS); + + return error; +} + +static unsigned addChunk_IDAT(ucvector* out, const unsigned char* data, size_t datasize, + LodePNGCompressSettings* zlibsettings) { + ucvector zlibdata; + unsigned error = 0; + + /*compress with the Zlib compressor*/ + ucvector_init(&zlibdata); + error = zlib_compress(&zlibdata.data, &zlibdata.size, data, datasize, zlibsettings); + if(!error) error = addChunk(out, "IDAT", zlibdata.data, zlibdata.size); + ucvector_cleanup(&zlibdata); + + return error; +} + +static unsigned addChunk_IEND(ucvector* out) { + unsigned error = 0; + error = addChunk(out, "IEND", 0, 0); + return error; +} + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + +static unsigned addChunk_tEXt(ucvector* out, const char* keyword, const char* textstring) { + unsigned error = 0; + size_t i; + ucvector text; + ucvector_init(&text); + for(i = 0; keyword[i] != 0; ++i) ucvector_push_back(&text, (unsigned char)keyword[i]); + if(i < 1 || i > 79) return 89; /*error: invalid keyword size*/ + ucvector_push_back(&text, 0); /*0 termination char*/ + for(i = 0; textstring[i] != 0; ++i) ucvector_push_back(&text, (unsigned char)textstring[i]); + error = addChunk(out, "tEXt", text.data, text.size); + ucvector_cleanup(&text); + + return error; +} + +static unsigned addChunk_zTXt(ucvector* out, const char* keyword, const char* textstring, + LodePNGCompressSettings* zlibsettings) { + unsigned error = 0; + ucvector data, compressed; + size_t i, textsize = strlen(textstring); + + ucvector_init(&data); + ucvector_init(&compressed); + for(i = 0; keyword[i] != 0; ++i) ucvector_push_back(&data, (unsigned char)keyword[i]); + if(i < 1 || i > 79) return 89; /*error: invalid keyword size*/ + ucvector_push_back(&data, 0); /*0 termination char*/ + ucvector_push_back(&data, 0); /*compression method: 0*/ + + error = zlib_compress(&compressed.data, &compressed.size, + (unsigned char*)textstring, textsize, zlibsettings); + if(!error) { + for(i = 0; i != compressed.size; ++i) ucvector_push_back(&data, compressed.data[i]); + error = addChunk(out, "zTXt", data.data, data.size); + } + + ucvector_cleanup(&compressed); + ucvector_cleanup(&data); + return error; +} + +static unsigned addChunk_iTXt(ucvector* out, unsigned compressed, const char* keyword, const char* langtag, + const char* transkey, const char* textstring, LodePNGCompressSettings* zlibsettings) { + unsigned error = 0; + ucvector data; + size_t i, textsize = strlen(textstring); + + ucvector_init(&data); + + for(i = 0; keyword[i] != 0; ++i) ucvector_push_back(&data, (unsigned char)keyword[i]); + if(i < 1 || i > 79) return 89; /*error: invalid keyword size*/ + ucvector_push_back(&data, 0); /*null termination char*/ + ucvector_push_back(&data, compressed ? 1 : 0); /*compression flag*/ + ucvector_push_back(&data, 0); /*compression method*/ + for(i = 0; langtag[i] != 0; ++i) ucvector_push_back(&data, (unsigned char)langtag[i]); + ucvector_push_back(&data, 0); /*null termination char*/ + for(i = 0; transkey[i] != 0; ++i) ucvector_push_back(&data, (unsigned char)transkey[i]); + ucvector_push_back(&data, 0); /*null termination char*/ + + if(compressed) { + ucvector compressed_data; + ucvector_init(&compressed_data); + error = zlib_compress(&compressed_data.data, &compressed_data.size, + (unsigned char*)textstring, textsize, zlibsettings); + if(!error) { + for(i = 0; i != compressed_data.size; ++i) ucvector_push_back(&data, compressed_data.data[i]); + } + ucvector_cleanup(&compressed_data); + } else /*not compressed*/ { + for(i = 0; textstring[i] != 0; ++i) ucvector_push_back(&data, (unsigned char)textstring[i]); + } + + if(!error) error = addChunk(out, "iTXt", data.data, data.size); + ucvector_cleanup(&data); + return error; +} + +static unsigned addChunk_bKGD(ucvector* out, const LodePNGInfo* info) { + unsigned error = 0; + ucvector bKGD; + ucvector_init(&bKGD); + if(info->color.colortype == LCT_GREY || info->color.colortype == LCT_GREY_ALPHA) { + ucvector_push_back(&bKGD, (unsigned char)(info->background_r >> 8)); + ucvector_push_back(&bKGD, (unsigned char)(info->background_r & 255)); + } else if(info->color.colortype == LCT_RGB || info->color.colortype == LCT_RGBA) { + ucvector_push_back(&bKGD, (unsigned char)(info->background_r >> 8)); + ucvector_push_back(&bKGD, (unsigned char)(info->background_r & 255)); + ucvector_push_back(&bKGD, (unsigned char)(info->background_g >> 8)); + ucvector_push_back(&bKGD, (unsigned char)(info->background_g & 255)); + ucvector_push_back(&bKGD, (unsigned char)(info->background_b >> 8)); + ucvector_push_back(&bKGD, (unsigned char)(info->background_b & 255)); + } else if(info->color.colortype == LCT_PALETTE) { + ucvector_push_back(&bKGD, (unsigned char)(info->background_r & 255)); /*palette index*/ + } + + error = addChunk(out, "bKGD", bKGD.data, bKGD.size); + ucvector_cleanup(&bKGD); + + return error; +} + +static unsigned addChunk_tIME(ucvector* out, const LodePNGTime* time) { + unsigned error = 0; + unsigned char* data = (unsigned char*)lodepng_malloc(7); + if(!data) return 83; /*alloc fail*/ + data[0] = (unsigned char)(time->year >> 8); + data[1] = (unsigned char)(time->year & 255); + data[2] = (unsigned char)time->month; + data[3] = (unsigned char)time->day; + data[4] = (unsigned char)time->hour; + data[5] = (unsigned char)time->minute; + data[6] = (unsigned char)time->second; + error = addChunk(out, "tIME", data, 7); + lodepng_free(data); + return error; +} + +static unsigned addChunk_pHYs(ucvector* out, const LodePNGInfo* info) { + unsigned error = 0; + ucvector data; + ucvector_init(&data); + + lodepng_add32bitInt(&data, info->phys_x); + lodepng_add32bitInt(&data, info->phys_y); + ucvector_push_back(&data, info->phys_unit); + + error = addChunk(out, "pHYs", data.data, data.size); + ucvector_cleanup(&data); + + return error; +} + +static unsigned addChunk_gAMA(ucvector* out, const LodePNGInfo* info) { + unsigned error = 0; + ucvector data; + ucvector_init(&data); + + lodepng_add32bitInt(&data, info->gama_gamma); + + error = addChunk(out, "gAMA", data.data, data.size); + ucvector_cleanup(&data); + + return error; +} + +static unsigned addChunk_cHRM(ucvector* out, const LodePNGInfo* info) { + unsigned error = 0; + ucvector data; + ucvector_init(&data); + + lodepng_add32bitInt(&data, info->chrm_white_x); + lodepng_add32bitInt(&data, info->chrm_white_y); + lodepng_add32bitInt(&data, info->chrm_red_x); + lodepng_add32bitInt(&data, info->chrm_red_y); + lodepng_add32bitInt(&data, info->chrm_green_x); + lodepng_add32bitInt(&data, info->chrm_green_y); + lodepng_add32bitInt(&data, info->chrm_blue_x); + lodepng_add32bitInt(&data, info->chrm_blue_y); + + error = addChunk(out, "cHRM", data.data, data.size); + ucvector_cleanup(&data); + + return error; +} + +static unsigned addChunk_sRGB(ucvector* out, const LodePNGInfo* info) { + unsigned char data = info->srgb_intent; + return addChunk(out, "sRGB", &data, 1); +} + +static unsigned addChunk_iCCP(ucvector* out, const LodePNGInfo* info, LodePNGCompressSettings* zlibsettings) { + unsigned error = 0; + ucvector data, compressed; + size_t i; + + ucvector_init(&data); + ucvector_init(&compressed); + for(i = 0; info->iccp_name[i] != 0; ++i) ucvector_push_back(&data, (unsigned char)info->iccp_name[i]); + if(i < 1 || i > 79) return 89; /*error: invalid keyword size*/ + ucvector_push_back(&data, 0); /*0 termination char*/ + ucvector_push_back(&data, 0); /*compression method: 0*/ + + error = zlib_compress(&compressed.data, &compressed.size, + info->iccp_profile, info->iccp_profile_size, zlibsettings); + if(!error) { + for(i = 0; i != compressed.size; ++i) ucvector_push_back(&data, compressed.data[i]); + error = addChunk(out, "iCCP", data.data, data.size); + } + + ucvector_cleanup(&compressed); + ucvector_cleanup(&data); + return error; +} + +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + +static void filterScanline(unsigned char* out, const unsigned char* scanline, const unsigned char* prevline, + size_t length, size_t bytewidth, unsigned char filterType) { + size_t i; + switch(filterType) { + case 0: /*None*/ + for(i = 0; i != length; ++i) out[i] = scanline[i]; + break; + case 1: /*Sub*/ + for(i = 0; i != bytewidth; ++i) out[i] = scanline[i]; + for(i = bytewidth; i < length; ++i) out[i] = scanline[i] - scanline[i - bytewidth]; + break; + case 2: /*Up*/ + if(prevline) { + for(i = 0; i != length; ++i) out[i] = scanline[i] - prevline[i]; + } else { + for(i = 0; i != length; ++i) out[i] = scanline[i]; + } + break; + case 3: /*Average*/ + if(prevline) { + for(i = 0; i != bytewidth; ++i) out[i] = scanline[i] - (prevline[i] >> 1); + for(i = bytewidth; i < length; ++i) out[i] = scanline[i] - ((scanline[i - bytewidth] + prevline[i]) >> 1); + } else { + for(i = 0; i != bytewidth; ++i) out[i] = scanline[i]; + for(i = bytewidth; i < length; ++i) out[i] = scanline[i] - (scanline[i - bytewidth] >> 1); + } + break; + case 4: /*Paeth*/ + if(prevline) { + /*paethPredictor(0, prevline[i], 0) is always prevline[i]*/ + for(i = 0; i != bytewidth; ++i) out[i] = (scanline[i] - prevline[i]); + for(i = bytewidth; i < length; ++i) { + out[i] = (scanline[i] - paethPredictor(scanline[i - bytewidth], prevline[i], prevline[i - bytewidth])); + } + } else { + for(i = 0; i != bytewidth; ++i) out[i] = scanline[i]; + /*paethPredictor(scanline[i - bytewidth], 0, 0) is always scanline[i - bytewidth]*/ + for(i = bytewidth; i < length; ++i) out[i] = (scanline[i] - scanline[i - bytewidth]); + } + break; + default: return; /*unexisting filter type given*/ + } +} + +/* log2 approximation. A slight bit faster than std::log. */ +static float flog2(float f) { + float result = 0; + while(f > 32) { result += 4; f /= 16; } + while(f > 2) { ++result; f /= 2; } + return result + 1.442695f * (f * f * f / 3 - 3 * f * f / 2 + 3 * f - 1.83333f); +} + +static unsigned filter(unsigned char* out, const unsigned char* in, unsigned w, unsigned h, + const LodePNGColorMode* info, const LodePNGEncoderSettings* settings) { + /* + For PNG filter method 0 + out must be a buffer with as size: h + (w * h * bpp + 7) / 8, because there are + the scanlines with 1 extra byte per scanline + */ + + unsigned bpp = lodepng_get_bpp(info); + /*the width of a scanline in bytes, not including the filter type*/ + size_t linebytes = (w * bpp + 7) / 8; + /*bytewidth is used for filtering, is 1 when bpp < 8, number of bytes per pixel otherwise*/ + size_t bytewidth = (bpp + 7) / 8; + const unsigned char* prevline = 0; + unsigned x, y; + unsigned error = 0; + LodePNGFilterStrategy strategy = settings->filter_strategy; + + /* + There is a heuristic called the minimum sum of absolute differences heuristic, suggested by the PNG standard: + * If the image type is Palette, or the bit depth is smaller than 8, then do not filter the image (i.e. + use fixed filtering, with the filter None). + * (The other case) If the image type is Grayscale or RGB (with or without Alpha), and the bit depth is + not smaller than 8, then use adaptive filtering heuristic as follows: independently for each row, apply + all five filters and select the filter that produces the smallest sum of absolute values per row. + This heuristic is used if filter strategy is LFS_MINSUM and filter_palette_zero is true. + + If filter_palette_zero is true and filter_strategy is not LFS_MINSUM, the above heuristic is followed, + but for "the other case", whatever strategy filter_strategy is set to instead of the minimum sum + heuristic is used. + */ + if(settings->filter_palette_zero && + (info->colortype == LCT_PALETTE || info->bitdepth < 8)) strategy = LFS_ZERO; + + if(bpp == 0) return 31; /*error: invalid color type*/ + + if(strategy == LFS_ZERO) { + for(y = 0; y != h; ++y) { + size_t outindex = (1 + linebytes) * y; /*the extra filterbyte added to each row*/ + size_t inindex = linebytes * y; + out[outindex] = 0; /*filter type byte*/ + filterScanline(&out[outindex + 1], &in[inindex], prevline, linebytes, bytewidth, 0); + prevline = &in[inindex]; + } + } else if(strategy == LFS_MINSUM) { + /*adaptive filtering*/ + size_t sum[5]; + unsigned char* attempt[5]; /*five filtering attempts, one for each filter type*/ + size_t smallest = 0; + unsigned char type, bestType = 0; + + for(type = 0; type != 5; ++type) { + attempt[type] = (unsigned char*)lodepng_malloc(linebytes); + if(!attempt[type]) return 83; /*alloc fail*/ + } + + if(!error) { + for(y = 0; y != h; ++y) { + /*try the 5 filter types*/ + for(type = 0; type != 5; ++type) { + filterScanline(attempt[type], &in[y * linebytes], prevline, linebytes, bytewidth, type); + + /*calculate the sum of the result*/ + sum[type] = 0; + if(type == 0) { + for(x = 0; x != linebytes; ++x) sum[type] += (unsigned char)(attempt[type][x]); + } else { + for(x = 0; x != linebytes; ++x) { + /*For differences, each byte should be treated as signed, values above 127 are negative + (converted to signed char). Filtertype 0 isn't a difference though, so use unsigned there. + This means filtertype 0 is almost never chosen, but that is justified.*/ + unsigned char s = attempt[type][x]; + sum[type] += s < 128 ? s : (255U - s); + } + } + + /*check if this is smallest sum (or if type == 0 it's the first case so always store the values)*/ + if(type == 0 || sum[type] < smallest) { + bestType = type; + smallest = sum[type]; + } + } + + prevline = &in[y * linebytes]; + + /*now fill the out values*/ + out[y * (linebytes + 1)] = bestType; /*the first byte of a scanline will be the filter type*/ + for(x = 0; x != linebytes; ++x) out[y * (linebytes + 1) + 1 + x] = attempt[bestType][x]; + } + } + + for(type = 0; type != 5; ++type) lodepng_free(attempt[type]); + } else if(strategy == LFS_ENTROPY) { + float sum[5]; + unsigned char* attempt[5]; /*five filtering attempts, one for each filter type*/ + float smallest = 0; + unsigned type, bestType = 0; + unsigned count[256]; + + for(type = 0; type != 5; ++type) { + attempt[type] = (unsigned char*)lodepng_malloc(linebytes); + if(!attempt[type]) return 83; /*alloc fail*/ + } + + for(y = 0; y != h; ++y) { + /*try the 5 filter types*/ + for(type = 0; type != 5; ++type) { + filterScanline(attempt[type], &in[y * linebytes], prevline, linebytes, bytewidth, type); + for(x = 0; x != 256; ++x) count[x] = 0; + for(x = 0; x != linebytes; ++x) ++count[attempt[type][x]]; + ++count[type]; /*the filter type itself is part of the scanline*/ + sum[type] = 0; + for(x = 0; x != 256; ++x) { + float p = count[x] / (float)(linebytes + 1); + sum[type] += count[x] == 0 ? 0 : flog2(1 / p) * p; + } + /*check if this is smallest sum (or if type == 0 it's the first case so always store the values)*/ + if(type == 0 || sum[type] < smallest) { + bestType = type; + smallest = sum[type]; + } + } + + prevline = &in[y * linebytes]; + + /*now fill the out values*/ + out[y * (linebytes + 1)] = bestType; /*the first byte of a scanline will be the filter type*/ + for(x = 0; x != linebytes; ++x) out[y * (linebytes + 1) + 1 + x] = attempt[bestType][x]; + } + + for(type = 0; type != 5; ++type) lodepng_free(attempt[type]); + } else if(strategy == LFS_PREDEFINED) { + for(y = 0; y != h; ++y) { + size_t outindex = (1 + linebytes) * y; /*the extra filterbyte added to each row*/ + size_t inindex = linebytes * y; + unsigned char type = settings->predefined_filters[y]; + out[outindex] = type; /*filter type byte*/ + filterScanline(&out[outindex + 1], &in[inindex], prevline, linebytes, bytewidth, type); + prevline = &in[inindex]; + } + } else if(strategy == LFS_BRUTE_FORCE) { + /*brute force filter chooser. + deflate the scanline after every filter attempt to see which one deflates best. + This is very slow and gives only slightly smaller, sometimes even larger, result*/ + size_t size[5]; + unsigned char* attempt[5]; /*five filtering attempts, one for each filter type*/ + size_t smallest = 0; + unsigned type = 0, bestType = 0; + unsigned char* dummy; + LodePNGCompressSettings zlibsettings = settings->zlibsettings; + /*use fixed tree on the attempts so that the tree is not adapted to the filtertype on purpose, + to simulate the true case where the tree is the same for the whole image. Sometimes it gives + better result with dynamic tree anyway. Using the fixed tree sometimes gives worse, but in rare + cases better compression. It does make this a bit less slow, so it's worth doing this.*/ + zlibsettings.btype = 1; + /*a custom encoder likely doesn't read the btype setting and is optimized for complete PNG + images only, so disable it*/ + zlibsettings.custom_zlib = 0; + zlibsettings.custom_deflate = 0; + for(type = 0; type != 5; ++type) { + attempt[type] = (unsigned char*)lodepng_malloc(linebytes); + if(!attempt[type]) return 83; /*alloc fail*/ + } + for(y = 0; y != h; ++y) /*try the 5 filter types*/ { + for(type = 0; type != 5; ++type) { + unsigned testsize = (unsigned)linebytes; + /*if(testsize > 8) testsize /= 8;*/ /*it already works good enough by testing a part of the row*/ + + filterScanline(attempt[type], &in[y * linebytes], prevline, linebytes, bytewidth, type); + size[type] = 0; + dummy = 0; + zlib_compress(&dummy, &size[type], attempt[type], testsize, &zlibsettings); + lodepng_free(dummy); + /*check if this is smallest size (or if type == 0 it's the first case so always store the values)*/ + if(type == 0 || size[type] < smallest) { + bestType = type; + smallest = size[type]; + } + } + prevline = &in[y * linebytes]; + out[y * (linebytes + 1)] = bestType; /*the first byte of a scanline will be the filter type*/ + for(x = 0; x != linebytes; ++x) out[y * (linebytes + 1) + 1 + x] = attempt[bestType][x]; + } + for(type = 0; type != 5; ++type) lodepng_free(attempt[type]); + } + else return 88; /* unknown filter strategy */ + + return error; +} + +static void addPaddingBits(unsigned char* out, const unsigned char* in, + size_t olinebits, size_t ilinebits, unsigned h) { + /*The opposite of the removePaddingBits function + olinebits must be >= ilinebits*/ + unsigned y; + size_t diff = olinebits - ilinebits; + size_t obp = 0, ibp = 0; /*bit pointers*/ + for(y = 0; y != h; ++y) { + size_t x; + for(x = 0; x < ilinebits; ++x) { + unsigned char bit = readBitFromReversedStream(&ibp, in); + setBitOfReversedStream(&obp, out, bit); + } + /*obp += diff; --> no, fill in some value in the padding bits too, to avoid + "Use of uninitialised value of size ###" warning from valgrind*/ + for(x = 0; x != diff; ++x) setBitOfReversedStream(&obp, out, 0); + } +} + +/* +in: non-interlaced image with size w*h +out: the same pixels, but re-ordered according to PNG's Adam7 interlacing, with + no padding bits between scanlines, but between reduced images so that each + reduced image starts at a byte. +bpp: bits per pixel +there are no padding bits, not between scanlines, not between reduced images +in has the following size in bits: w * h * bpp. +out is possibly bigger due to padding bits between reduced images +NOTE: comments about padding bits are only relevant if bpp < 8 +*/ +static void Adam7_interlace(unsigned char* out, const unsigned char* in, unsigned w, unsigned h, unsigned bpp) { + unsigned passw[7], passh[7]; + size_t filter_passstart[8], padded_passstart[8], passstart[8]; + unsigned i; + + Adam7_getpassvalues(passw, passh, filter_passstart, padded_passstart, passstart, w, h, bpp); + + if(bpp >= 8) { + for(i = 0; i != 7; ++i) { + unsigned x, y, b; + size_t bytewidth = bpp / 8; + for(y = 0; y < passh[i]; ++y) + for(x = 0; x < passw[i]; ++x) { + size_t pixelinstart = ((ADAM7_IY[i] + y * ADAM7_DY[i]) * w + ADAM7_IX[i] + x * ADAM7_DX[i]) * bytewidth; + size_t pixeloutstart = passstart[i] + (y * passw[i] + x) * bytewidth; + for(b = 0; b < bytewidth; ++b) { + out[pixeloutstart + b] = in[pixelinstart + b]; + } + } + } + } else /*bpp < 8: Adam7 with pixels < 8 bit is a bit trickier: with bit pointers*/ { + for(i = 0; i != 7; ++i) { + unsigned x, y, b; + unsigned ilinebits = bpp * passw[i]; + unsigned olinebits = bpp * w; + size_t obp, ibp; /*bit pointers (for out and in buffer)*/ + for(y = 0; y < passh[i]; ++y) + for(x = 0; x < passw[i]; ++x) { + ibp = (ADAM7_IY[i] + y * ADAM7_DY[i]) * olinebits + (ADAM7_IX[i] + x * ADAM7_DX[i]) * bpp; + obp = (8 * passstart[i]) + (y * ilinebits + x * bpp); + for(b = 0; b < bpp; ++b) { + unsigned char bit = readBitFromReversedStream(&ibp, in); + setBitOfReversedStream(&obp, out, bit); + } + } + } + } +} + +/*out must be buffer big enough to contain uncompressed IDAT chunk data, and in must contain the full image. +return value is error**/ +static unsigned preProcessScanlines(unsigned char** out, size_t* outsize, const unsigned char* in, + unsigned w, unsigned h, + const LodePNGInfo* info_png, const LodePNGEncoderSettings* settings) { + /* + This function converts the pure 2D image with the PNG's colortype, into filtered-padded-interlaced data. Steps: + *) if no Adam7: 1) add padding bits (= posible extra bits per scanline if bpp < 8) 2) filter + *) if adam7: 1) Adam7_interlace 2) 7x add padding bits 3) 7x filter + */ + unsigned bpp = lodepng_get_bpp(&info_png->color); + unsigned error = 0; + + if(info_png->interlace_method == 0) { + *outsize = h + (h * ((w * bpp + 7) / 8)); /*image size plus an extra byte per scanline + possible padding bits*/ + *out = (unsigned char*)lodepng_malloc(*outsize); + if(!(*out) && (*outsize)) error = 83; /*alloc fail*/ + + if(!error) { + /*non multiple of 8 bits per scanline, padding bits needed per scanline*/ + if(bpp < 8 && w * bpp != ((w * bpp + 7) / 8) * 8) { + unsigned char* padded = (unsigned char*)lodepng_malloc(h * ((w * bpp + 7) / 8)); + if(!padded) error = 83; /*alloc fail*/ + if(!error) { + addPaddingBits(padded, in, ((w * bpp + 7) / 8) * 8, w * bpp, h); + error = filter(*out, padded, w, h, &info_png->color, settings); + } + lodepng_free(padded); + } else { + /*we can immediately filter into the out buffer, no other steps needed*/ + error = filter(*out, in, w, h, &info_png->color, settings); + } + } + } else /*interlace_method is 1 (Adam7)*/ { + unsigned passw[7], passh[7]; + size_t filter_passstart[8], padded_passstart[8], passstart[8]; + unsigned char* adam7; + + Adam7_getpassvalues(passw, passh, filter_passstart, padded_passstart, passstart, w, h, bpp); + + *outsize = filter_passstart[7]; /*image size plus an extra byte per scanline + possible padding bits*/ + *out = (unsigned char*)lodepng_malloc(*outsize); + if(!(*out)) error = 83; /*alloc fail*/ + + adam7 = (unsigned char*)lodepng_malloc(passstart[7]); + if(!adam7 && passstart[7]) error = 83; /*alloc fail*/ + + if(!error) { + unsigned i; + + Adam7_interlace(adam7, in, w, h, bpp); + for(i = 0; i != 7; ++i) { + if(bpp < 8) { + unsigned char* padded = (unsigned char*)lodepng_malloc(padded_passstart[i + 1] - padded_passstart[i]); + if(!padded) ERROR_BREAK(83); /*alloc fail*/ + addPaddingBits(padded, &adam7[passstart[i]], + ((passw[i] * bpp + 7) / 8) * 8, passw[i] * bpp, passh[i]); + error = filter(&(*out)[filter_passstart[i]], padded, + passw[i], passh[i], &info_png->color, settings); + lodepng_free(padded); + } else { + error = filter(&(*out)[filter_passstart[i]], &adam7[padded_passstart[i]], + passw[i], passh[i], &info_png->color, settings); + } + + if(error) break; + } + } + + lodepng_free(adam7); + } + + return error; +} + +/* +palette must have 4 * palettesize bytes allocated, and given in format RGBARGBARGBARGBA... +returns 0 if the palette is opaque, +returns 1 if the palette has a single color with alpha 0 ==> color key +returns 2 if the palette is semi-translucent. +*/ +static unsigned getPaletteTranslucency(const unsigned char* palette, size_t palettesize) { + size_t i; + unsigned key = 0; + unsigned r = 0, g = 0, b = 0; /*the value of the color with alpha 0, so long as color keying is possible*/ + for(i = 0; i != palettesize; ++i) { + if(!key && palette[4 * i + 3] == 0) { + r = palette[4 * i + 0]; g = palette[4 * i + 1]; b = palette[4 * i + 2]; + key = 1; + i = (size_t)(-1); /*restart from beginning, to detect earlier opaque colors with key's value*/ + } + else if(palette[4 * i + 3] != 255) return 2; + /*when key, no opaque RGB may have key's RGB*/ + else if(key && r == palette[i * 4 + 0] && g == palette[i * 4 + 1] && b == palette[i * 4 + 2]) return 2; + } + return key; +} + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS +static unsigned addUnknownChunks(ucvector* out, unsigned char* data, size_t datasize) { + unsigned char* inchunk = data; + while((size_t)(inchunk - data) < datasize) { + CERROR_TRY_RETURN(lodepng_chunk_append(&out->data, &out->size, inchunk)); + out->allocsize = out->size; /*fix the allocsize again*/ + inchunk = lodepng_chunk_next(inchunk); + } + return 0; +} + +static unsigned isGrayICCProfile(const unsigned char* profile, unsigned size) { + /* + It is a gray profile if bytes 16-19 are "GRAY", rgb profile if bytes 16-19 + are "RGB ". We do not perform any full parsing of the ICC profile here, other + than check those 4 bytes to grayscale profile. Other than that, validity of + the profile is not checked. This is needed only because the PNG specification + requires using a non-gray color model if there is an ICC profile with "RGB " + (sadly limiting compression opportunities if the input data is grayscale RGB + data), and requires using a gray color model if it is "GRAY". + */ + if(size < 20) return 0; + return profile[16] == 'G' && profile[17] == 'R' && profile[18] == 'A' && profile[19] == 'Y'; +} + +static unsigned isRGBICCProfile(const unsigned char* profile, unsigned size) { + /* See comment in isGrayICCProfile*/ + if(size < 20) return 0; + return profile[16] == 'R' && profile[17] == 'G' && profile[18] == 'B' && profile[19] == ' '; +} +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + +unsigned lodepng_encode(unsigned char** out, size_t* outsize, + const unsigned char* image, unsigned w, unsigned h, + LodePNGState* state) { + unsigned char* data = 0; /*uncompressed version of the IDAT chunk data*/ + size_t datasize = 0; + ucvector outv; + LodePNGInfo info; + + ucvector_init(&outv); + lodepng_info_init(&info); + + /*provide some proper output values if error will happen*/ + *out = 0; + *outsize = 0; + state->error = 0; + + /*check input values validity*/ + if((state->info_png.color.colortype == LCT_PALETTE || state->encoder.force_palette) + && (state->info_png.color.palettesize == 0 || state->info_png.color.palettesize > 256)) { + state->error = 68; /*invalid palette size, it is only allowed to be 1-256*/ + goto cleanup; + } + if(state->encoder.zlibsettings.btype > 2) { + state->error = 61; /*error: unexisting btype*/ + goto cleanup; + } + if(state->info_png.interlace_method > 1) { + state->error = 71; /*error: unexisting interlace mode*/ + goto cleanup; + } + state->error = checkColorValidity(state->info_png.color.colortype, state->info_png.color.bitdepth); + if(state->error) goto cleanup; /*error: unexisting color type given*/ + state->error = checkColorValidity(state->info_raw.colortype, state->info_raw.bitdepth); + if(state->error) goto cleanup; /*error: unexisting color type given*/ + + /* color convert and compute scanline filter types */ + lodepng_info_copy(&info, &state->info_png); + if(state->encoder.auto_convert) { +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + if(state->info_png.background_defined) { + unsigned bg_r = state->info_png.background_r; + unsigned bg_g = state->info_png.background_g; + unsigned bg_b = state->info_png.background_b; + unsigned r = 0, g = 0, b = 0; + LodePNGColorProfile prof; + LodePNGColorMode mode16 = lodepng_color_mode_make(LCT_RGB, 16); + lodepng_convert_rgb(&r, &g, &b, bg_r, bg_g, bg_b, &mode16, &state->info_png.color); + lodepng_color_profile_init(&prof); + state->error = lodepng_get_color_profile(&prof, image, w, h, &state->info_raw); + if(state->error) goto cleanup; + lodepng_color_profile_add(&prof, r, g, b, 65535); + state->error = auto_choose_color_from_profile(&info.color, &state->info_raw, &prof); + if(state->error) goto cleanup; + if(lodepng_convert_rgb(&info.background_r, &info.background_g, &info.background_b, + bg_r, bg_g, bg_b, &info.color, &state->info_png.color)) { + state->error = 104; + goto cleanup; + } + } + else +#endif /* LODEPNG_COMPILE_ANCILLARY_CHUNKS */ + { + state->error = lodepng_auto_choose_color(&info.color, image, w, h, &state->info_raw); + if(state->error) goto cleanup; + } + } +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + if(state->info_png.iccp_defined) { + unsigned gray_icc = isGrayICCProfile(state->info_png.iccp_profile, state->info_png.iccp_profile_size); + unsigned gray_png = info.color.colortype == LCT_GREY || info.color.colortype == LCT_GREY_ALPHA; + /* TODO: perhaps instead of giving errors or less optimal compression, we can automatically modify + the ICC profile here to say "GRAY" or "RGB " to match the PNG color type, unless this will require + non trivial changes to the rest of the ICC profile */ + if(!gray_icc && !isRGBICCProfile(state->info_png.iccp_profile, state->info_png.iccp_profile_size)) { + state->error = 100; /* Disallowed profile color type for PNG */ + goto cleanup; + } + if(!state->encoder.auto_convert && gray_icc != gray_png) { + /* Non recoverable: encoder not allowed to convert color type, and requested color type not + compatible with ICC color type */ + state->error = 101; + goto cleanup; + } + if(gray_icc && !gray_png) { + /* Non recoverable: trying to set grayscale ICC profile while colored pixels were given */ + state->error = 102; + goto cleanup; + /* NOTE: this relies on the fact that lodepng_auto_choose_color never returns palette for grayscale pixels */ + } + if(!gray_icc && gray_png) { + /* Recoverable but an unfortunate loss in compression density: We have grayscale pixels but + are forced to store them in more expensive RGB format that will repeat each value 3 times + because the PNG spec does not allow an RGB ICC profile with internal grayscale color data */ + if(info.color.colortype == LCT_GREY) info.color.colortype = LCT_RGB; + if(info.color.colortype == LCT_GREY_ALPHA) info.color.colortype = LCT_RGBA; + if(info.color.bitdepth < 8) info.color.bitdepth = 8; + } + } +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + if(!lodepng_color_mode_equal(&state->info_raw, &info.color)) { + unsigned char* converted; + size_t size = ((size_t)w * (size_t)h * (size_t)lodepng_get_bpp(&info.color) + 7) / 8; + + converted = (unsigned char*)lodepng_malloc(size); + if(!converted && size) state->error = 83; /*alloc fail*/ + if(!state->error) { + state->error = lodepng_convert(converted, image, &info.color, &state->info_raw, w, h); + } + if(!state->error) preProcessScanlines(&data, &datasize, converted, w, h, &info, &state->encoder); + lodepng_free(converted); + if(state->error) goto cleanup; + } + else preProcessScanlines(&data, &datasize, image, w, h, &info, &state->encoder); + + /* output all PNG chunks */ { +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + size_t i; +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + /*write signature and chunks*/ + writeSignature(&outv); + /*IHDR*/ + addChunk_IHDR(&outv, w, h, info.color.colortype, info.color.bitdepth, info.interlace_method); +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + /*unknown chunks between IHDR and PLTE*/ + if(info.unknown_chunks_data[0]) { + state->error = addUnknownChunks(&outv, info.unknown_chunks_data[0], info.unknown_chunks_size[0]); + if(state->error) goto cleanup; + } + /*color profile chunks must come before PLTE */ + if(info.iccp_defined) addChunk_iCCP(&outv, &info, &state->encoder.zlibsettings); + if(info.srgb_defined) addChunk_sRGB(&outv, &info); + if(info.gama_defined) addChunk_gAMA(&outv, &info); + if(info.chrm_defined) addChunk_cHRM(&outv, &info); +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + /*PLTE*/ + if(info.color.colortype == LCT_PALETTE) { + addChunk_PLTE(&outv, &info.color); + } + if(state->encoder.force_palette && (info.color.colortype == LCT_RGB || info.color.colortype == LCT_RGBA)) { + addChunk_PLTE(&outv, &info.color); + } + /*tRNS*/ + if(info.color.colortype == LCT_PALETTE && getPaletteTranslucency(info.color.palette, info.color.palettesize) != 0) { + addChunk_tRNS(&outv, &info.color); + } + if((info.color.colortype == LCT_GREY || info.color.colortype == LCT_RGB) && info.color.key_defined) { + addChunk_tRNS(&outv, &info.color); + } +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + /*bKGD (must come between PLTE and the IDAt chunks*/ + if(info.background_defined) { + state->error = addChunk_bKGD(&outv, &info); + if(state->error) goto cleanup; + } + /*pHYs (must come before the IDAT chunks)*/ + if(info.phys_defined) addChunk_pHYs(&outv, &info); + + /*unknown chunks between PLTE and IDAT*/ + if(info.unknown_chunks_data[1]) { + state->error = addUnknownChunks(&outv, info.unknown_chunks_data[1], info.unknown_chunks_size[1]); + if(state->error) goto cleanup; + } +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + /*IDAT (multiple IDAT chunks must be consecutive)*/ + state->error = addChunk_IDAT(&outv, data, datasize, &state->encoder.zlibsettings); + if(state->error) goto cleanup; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + /*tIME*/ + if(info.time_defined) addChunk_tIME(&outv, &info.time); + /*tEXt and/or zTXt*/ + for(i = 0; i != info.text_num; ++i) { + if(strlen(info.text_keys[i]) > 79) { + state->error = 66; /*text chunk too large*/ + goto cleanup; + } + if(strlen(info.text_keys[i]) < 1) { + state->error = 67; /*text chunk too small*/ + goto cleanup; + } + if(state->encoder.text_compression) { + addChunk_zTXt(&outv, info.text_keys[i], info.text_strings[i], &state->encoder.zlibsettings); + } else { + addChunk_tEXt(&outv, info.text_keys[i], info.text_strings[i]); + } + } + /*LodePNG version id in text chunk*/ + if(state->encoder.add_id) { + unsigned already_added_id_text = 0; + for(i = 0; i != info.text_num; ++i) { + if(!strcmp(info.text_keys[i], "LodePNG")) { + already_added_id_text = 1; + break; + } + } + if(already_added_id_text == 0) { + addChunk_tEXt(&outv, "LodePNG", LODEPNG_VERSION_STRING); /*it's shorter as tEXt than as zTXt chunk*/ + } + } + /*iTXt*/ + for(i = 0; i != info.itext_num; ++i) { + if(strlen(info.itext_keys[i]) > 79) { + state->error = 66; /*text chunk too large*/ + goto cleanup; + } + if(strlen(info.itext_keys[i]) < 1) { + state->error = 67; /*text chunk too small*/ + goto cleanup; + } + addChunk_iTXt(&outv, state->encoder.text_compression, + info.itext_keys[i], info.itext_langtags[i], info.itext_transkeys[i], info.itext_strings[i], + &state->encoder.zlibsettings); + } + + /*unknown chunks between IDAT and IEND*/ + if(info.unknown_chunks_data[2]) { + state->error = addUnknownChunks(&outv, info.unknown_chunks_data[2], info.unknown_chunks_size[2]); + if(state->error) goto cleanup; + } +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + addChunk_IEND(&outv); + } + +cleanup: + lodepng_info_cleanup(&info); + lodepng_free(data); + + /*instead of cleaning the vector up, give it to the output*/ + *out = outv.data; + *outsize = outv.size; + + return state->error; +} + +unsigned lodepng_encode_memory(unsigned char** out, size_t* outsize, const unsigned char* image, + unsigned w, unsigned h, LodePNGColorType colortype, unsigned bitdepth) { + unsigned error; + LodePNGState state; + lodepng_state_init(&state); + state.info_raw.colortype = colortype; + state.info_raw.bitdepth = bitdepth; + state.info_png.color.colortype = colortype; + state.info_png.color.bitdepth = bitdepth; + lodepng_encode(out, outsize, image, w, h, &state); + error = state.error; + lodepng_state_cleanup(&state); + return error; +} + +unsigned lodepng_encode32(unsigned char** out, size_t* outsize, const unsigned char* image, unsigned w, unsigned h) { + return lodepng_encode_memory(out, outsize, image, w, h, LCT_RGBA, 8); +} + +unsigned lodepng_encode24(unsigned char** out, size_t* outsize, const unsigned char* image, unsigned w, unsigned h) { + return lodepng_encode_memory(out, outsize, image, w, h, LCT_RGB, 8); +} + +#ifdef LODEPNG_COMPILE_DISK +unsigned lodepng_encode_file(const char* filename, const unsigned char* image, unsigned w, unsigned h, + LodePNGColorType colortype, unsigned bitdepth) { + unsigned char* buffer; + size_t buffersize; + unsigned error = lodepng_encode_memory(&buffer, &buffersize, image, w, h, colortype, bitdepth); + if(!error) error = lodepng_save_file(buffer, buffersize, filename); + lodepng_free(buffer); + return error; +} + +unsigned lodepng_encode32_file(const char* filename, const unsigned char* image, unsigned w, unsigned h) { + return lodepng_encode_file(filename, image, w, h, LCT_RGBA, 8); +} + +unsigned lodepng_encode24_file(const char* filename, const unsigned char* image, unsigned w, unsigned h) { + return lodepng_encode_file(filename, image, w, h, LCT_RGB, 8); +} +#endif /*LODEPNG_COMPILE_DISK*/ + +void lodepng_encoder_settings_init(LodePNGEncoderSettings* settings) { + lodepng_compress_settings_init(&settings->zlibsettings); + settings->filter_palette_zero = 1; + settings->filter_strategy = LFS_MINSUM; + settings->auto_convert = 1; + settings->force_palette = 0; + settings->predefined_filters = 0; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + settings->add_id = 0; + settings->text_compression = 1; +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ +} + +#endif /*LODEPNG_COMPILE_ENCODER*/ +#endif /*LODEPNG_COMPILE_PNG*/ + +#ifdef LODEPNG_COMPILE_ERROR_TEXT +/* +This returns the description of a numerical error code in English. This is also +the documentation of all the error codes. +*/ +const char* lodepng_error_text(unsigned code) { + switch(code) { + case 0: return "no error, everything went ok"; + case 1: return "nothing done yet"; /*the Encoder/Decoder has done nothing yet, error checking makes no sense yet*/ + case 10: return "end of input memory reached without huffman end code"; /*while huffman decoding*/ + case 11: return "error in code tree made it jump outside of huffman tree"; /*while huffman decoding*/ + case 13: return "problem while processing dynamic deflate block"; + case 14: return "problem while processing dynamic deflate block"; + case 15: return "problem while processing dynamic deflate block"; + case 16: return "unexisting code while processing dynamic deflate block"; + case 17: return "end of out buffer memory reached while inflating"; + case 18: return "invalid distance code while inflating"; + case 19: return "end of out buffer memory reached while inflating"; + case 20: return "invalid deflate block BTYPE encountered while decoding"; + case 21: return "NLEN is not ones complement of LEN in a deflate block"; + + /*end of out buffer memory reached while inflating: + This can happen if the inflated deflate data is longer than the amount of bytes required to fill up + all the pixels of the image, given the color depth and image dimensions. Something that doesn't + happen in a normal, well encoded, PNG image.*/ + case 22: return "end of out buffer memory reached while inflating"; + case 23: return "end of in buffer memory reached while inflating"; + case 24: return "invalid FCHECK in zlib header"; + case 25: return "invalid compression method in zlib header"; + case 26: return "FDICT encountered in zlib header while it's not used for PNG"; + case 27: return "PNG file is smaller than a PNG header"; + /*Checks the magic file header, the first 8 bytes of the PNG file*/ + case 28: return "incorrect PNG signature, it's no PNG or corrupted"; + case 29: return "first chunk is not the header chunk"; + case 30: return "chunk length too large, chunk broken off at end of file"; + case 31: return "illegal PNG color type or bpp"; + case 32: return "illegal PNG compression method"; + case 33: return "illegal PNG filter method"; + case 34: return "illegal PNG interlace method"; + case 35: return "chunk length of a chunk is too large or the chunk too small"; + case 36: return "illegal PNG filter type encountered"; + case 37: return "illegal bit depth for this color type given"; + case 38: return "the palette is too big"; /*more than 256 colors*/ + case 39: return "tRNS chunk before PLTE or has more entries than palette size"; + case 40: return "tRNS chunk has wrong size for grayscale image"; + case 41: return "tRNS chunk has wrong size for RGB image"; + case 42: return "tRNS chunk appeared while it was not allowed for this color type"; + case 43: return "bKGD chunk has wrong size for palette image"; + case 44: return "bKGD chunk has wrong size for grayscale image"; + case 45: return "bKGD chunk has wrong size for RGB image"; + case 48: return "empty input buffer given to decoder. Maybe caused by non-existing file?"; + case 49: return "jumped past memory while generating dynamic huffman tree"; + case 50: return "jumped past memory while generating dynamic huffman tree"; + case 51: return "jumped past memory while inflating huffman block"; + case 52: return "jumped past memory while inflating"; + case 53: return "size of zlib data too small"; + case 54: return "repeat symbol in tree while there was no value symbol yet"; + /*jumped past tree while generating huffman tree, this could be when the + tree will have more leaves than symbols after generating it out of the + given lenghts. They call this an oversubscribed dynamic bit lengths tree in zlib.*/ + case 55: return "jumped past tree while generating huffman tree"; + case 56: return "given output image colortype or bitdepth not supported for color conversion"; + case 57: return "invalid CRC encountered (checking CRC can be disabled)"; + case 58: return "invalid ADLER32 encountered (checking ADLER32 can be disabled)"; + case 59: return "requested color conversion not supported"; + case 60: return "invalid window size given in the settings of the encoder (must be 0-32768)"; + case 61: return "invalid BTYPE given in the settings of the encoder (only 0, 1 and 2 are allowed)"; + /*LodePNG leaves the choice of RGB to grayscale conversion formula to the user.*/ + case 62: return "conversion from color to grayscale not supported"; + /*(2^31-1)*/ + case 63: return "length of a chunk too long, max allowed for PNG is 2147483647 bytes per chunk"; + /*this would result in the inability of a deflated block to ever contain an end code. It must be at least 1.*/ + case 64: return "the length of the END symbol 256 in the Huffman tree is 0"; + case 66: return "the length of a text chunk keyword given to the encoder is longer than the maximum of 79 bytes"; + case 67: return "the length of a text chunk keyword given to the encoder is smaller than the minimum of 1 byte"; + case 68: return "tried to encode a PLTE chunk with a palette that has less than 1 or more than 256 colors"; + case 69: return "unknown chunk type with 'critical' flag encountered by the decoder"; + case 71: return "unexisting interlace mode given to encoder (must be 0 or 1)"; + case 72: return "while decoding, unexisting compression method encountering in zTXt or iTXt chunk (it must be 0)"; + case 73: return "invalid tIME chunk size"; + case 74: return "invalid pHYs chunk size"; + /*length could be wrong, or data chopped off*/ + case 75: return "no null termination char found while decoding text chunk"; + case 76: return "iTXt chunk too short to contain required bytes"; + case 77: return "integer overflow in buffer size"; + case 78: return "failed to open file for reading"; /*file doesn't exist or couldn't be opened for reading*/ + case 79: return "failed to open file for writing"; + case 80: return "tried creating a tree of 0 symbols"; + case 81: return "lazy matching at pos 0 is impossible"; + case 82: return "color conversion to palette requested while a color isn't in palette, or index out of bounds"; + case 83: return "memory allocation failed"; + case 84: return "given image too small to contain all pixels to be encoded"; + case 86: return "impossible offset in lz77 encoding (internal bug)"; + case 87: return "must provide custom zlib function pointer if LODEPNG_COMPILE_ZLIB is not defined"; + case 88: return "invalid filter strategy given for LodePNGEncoderSettings.filter_strategy"; + case 89: return "text chunk keyword too short or long: must have size 1-79"; + /*the windowsize in the LodePNGCompressSettings. Requiring POT(==> & instead of %) makes encoding 12% faster.*/ + case 90: return "windowsize must be a power of two"; + case 91: return "invalid decompressed idat size"; + case 92: return "integer overflow due to too many pixels"; + case 93: return "zero width or height is invalid"; + case 94: return "header chunk must have a size of 13 bytes"; + case 95: return "integer overflow with combined idat chunk size"; + case 96: return "invalid gAMA chunk size"; + case 97: return "invalid cHRM chunk size"; + case 98: return "invalid sRGB chunk size"; + case 99: return "invalid sRGB rendering intent"; + case 100: return "invalid ICC profile color type, the PNG specification only allows RGB or GRAY"; + case 101: return "PNG specification does not allow RGB ICC profile on gray color types and vice versa"; + case 102: return "not allowed to set grayscale ICC profile with colored pixels by PNG specification"; + case 103: return "invalid palette index in bKGD chunk. Maybe it came before PLTE chunk?"; + case 104: return "invalid bKGD color while encoding (e.g. palette index out of range)"; + } + return "unknown error code"; +} +#endif /*LODEPNG_COMPILE_ERROR_TEXT*/ + +/* ////////////////////////////////////////////////////////////////////////// */ +/* ////////////////////////////////////////////////////////////////////////// */ +/* // C++ Wrapper // */ +/* ////////////////////////////////////////////////////////////////////////// */ +/* ////////////////////////////////////////////////////////////////////////// */ + +#ifdef LODEPNG_COMPILE_CPP +namespace lodepng { + +#ifdef LODEPNG_COMPILE_DISK +unsigned load_file(std::vector& buffer, const std::string& filename) { + long size = lodepng_filesize(filename.c_str()); + if(size < 0) return 78; + buffer.resize((size_t)size); + return size == 0 ? 0 : lodepng_buffer_file(&buffer[0], (size_t)size, filename.c_str()); +} + +/*write given buffer to the file, overwriting the file, it doesn't append to it.*/ +unsigned save_file(const std::vector& buffer, const std::string& filename) { + return lodepng_save_file(buffer.empty() ? 0 : &buffer[0], buffer.size(), filename.c_str()); +} +#endif /* LODEPNG_COMPILE_DISK */ + +#ifdef LODEPNG_COMPILE_ZLIB +#ifdef LODEPNG_COMPILE_DECODER +unsigned decompress(std::vector& out, const unsigned char* in, size_t insize, + const LodePNGDecompressSettings& settings) { + unsigned char* buffer = 0; + size_t buffersize = 0; + unsigned error = zlib_decompress(&buffer, &buffersize, in, insize, &settings); + if(buffer) { + out.insert(out.end(), &buffer[0], &buffer[buffersize]); + lodepng_free(buffer); + } + return error; +} + +unsigned decompress(std::vector& out, const std::vector& in, + const LodePNGDecompressSettings& settings) { + return decompress(out, in.empty() ? 0 : &in[0], in.size(), settings); +} +#endif /* LODEPNG_COMPILE_DECODER */ + +#ifdef LODEPNG_COMPILE_ENCODER +unsigned compress(std::vector& out, const unsigned char* in, size_t insize, + const LodePNGCompressSettings& settings) { + unsigned char* buffer = 0; + size_t buffersize = 0; + unsigned error = zlib_compress(&buffer, &buffersize, in, insize, &settings); + if(buffer) { + out.insert(out.end(), &buffer[0], &buffer[buffersize]); + lodepng_free(buffer); + } + return error; +} + +unsigned compress(std::vector& out, const std::vector& in, + const LodePNGCompressSettings& settings) { + return compress(out, in.empty() ? 0 : &in[0], in.size(), settings); +} +#endif /* LODEPNG_COMPILE_ENCODER */ +#endif /* LODEPNG_COMPILE_ZLIB */ + + +#ifdef LODEPNG_COMPILE_PNG + +State::State() { + lodepng_state_init(this); +} + +State::State(const State& other) { + lodepng_state_init(this); + lodepng_state_copy(this, &other); +} + +State::~State() { + lodepng_state_cleanup(this); +} + +State& State::operator=(const State& other) { + lodepng_state_copy(this, &other); + return *this; +} + +#ifdef LODEPNG_COMPILE_DECODER + +unsigned decode(std::vector& out, unsigned& w, unsigned& h, const unsigned char* in, + size_t insize, LodePNGColorType colortype, unsigned bitdepth) { + unsigned char* buffer; + unsigned error = lodepng_decode_memory(&buffer, &w, &h, in, insize, colortype, bitdepth); + if(buffer && !error) { + State state; + state.info_raw.colortype = colortype; + state.info_raw.bitdepth = bitdepth; + size_t buffersize = lodepng_get_raw_size(w, h, &state.info_raw); + out.insert(out.end(), &buffer[0], &buffer[buffersize]); + lodepng_free(buffer); + } + return error; +} + +unsigned decode(std::vector& out, unsigned& w, unsigned& h, + const std::vector& in, LodePNGColorType colortype, unsigned bitdepth) { + return decode(out, w, h, in.empty() ? 0 : &in[0], (unsigned)in.size(), colortype, bitdepth); +} + +unsigned decode(std::vector& out, unsigned& w, unsigned& h, + State& state, + const unsigned char* in, size_t insize) { + unsigned char* buffer = NULL; + unsigned error = lodepng_decode(&buffer, &w, &h, &state, in, insize); + if(buffer && !error) { + size_t buffersize = lodepng_get_raw_size(w, h, &state.info_raw); + out.insert(out.end(), &buffer[0], &buffer[buffersize]); + } + lodepng_free(buffer); + return error; +} + +unsigned decode(std::vector& out, unsigned& w, unsigned& h, + State& state, + const std::vector& in) { + return decode(out, w, h, state, in.empty() ? 0 : &in[0], in.size()); +} + +#ifdef LODEPNG_COMPILE_DISK +unsigned decode(std::vector& out, unsigned& w, unsigned& h, const std::string& filename, + LodePNGColorType colortype, unsigned bitdepth) { + std::vector buffer; + /* safe output values in case error happens */ + w = h = 0; + unsigned error = load_file(buffer, filename); + if(error) return error; + return decode(out, w, h, buffer, colortype, bitdepth); +} +#endif /* LODEPNG_COMPILE_DECODER */ +#endif /* LODEPNG_COMPILE_DISK */ + +#ifdef LODEPNG_COMPILE_ENCODER +unsigned encode(std::vector& out, const unsigned char* in, unsigned w, unsigned h, + LodePNGColorType colortype, unsigned bitdepth) { + unsigned char* buffer; + size_t buffersize; + unsigned error = lodepng_encode_memory(&buffer, &buffersize, in, w, h, colortype, bitdepth); + if(buffer) { + out.insert(out.end(), &buffer[0], &buffer[buffersize]); + lodepng_free(buffer); + } + return error; +} + +unsigned encode(std::vector& out, + const std::vector& in, unsigned w, unsigned h, + LodePNGColorType colortype, unsigned bitdepth) { + if(lodepng_get_raw_size_lct(w, h, colortype, bitdepth) > in.size()) return 84; + return encode(out, in.empty() ? 0 : &in[0], w, h, colortype, bitdepth); +} + +unsigned encode(std::vector& out, + const unsigned char* in, unsigned w, unsigned h, + State& state) { + unsigned char* buffer; + size_t buffersize; + unsigned error = lodepng_encode(&buffer, &buffersize, in, w, h, &state); + if(buffer) { + out.insert(out.end(), &buffer[0], &buffer[buffersize]); + lodepng_free(buffer); + } + return error; +} + +unsigned encode(std::vector& out, + const std::vector& in, unsigned w, unsigned h, + State& state) { + if(lodepng_get_raw_size(w, h, &state.info_raw) > in.size()) return 84; + return encode(out, in.empty() ? 0 : &in[0], w, h, state); +} + +#ifdef LODEPNG_COMPILE_DISK +unsigned encode(const std::string& filename, + const unsigned char* in, unsigned w, unsigned h, + LodePNGColorType colortype, unsigned bitdepth) { + std::vector buffer; + unsigned error = encode(buffer, in, w, h, colortype, bitdepth); + if(!error) error = save_file(buffer, filename); + return error; +} + +unsigned encode(const std::string& filename, + const std::vector& in, unsigned w, unsigned h, + LodePNGColorType colortype, unsigned bitdepth) { + if(lodepng_get_raw_size_lct(w, h, colortype, bitdepth) > in.size()) return 84; + return encode(filename, in.empty() ? 0 : &in[0], w, h, colortype, bitdepth); +} +#endif /* LODEPNG_COMPILE_DISK */ +#endif /* LODEPNG_COMPILE_ENCODER */ +#endif /* LODEPNG_COMPILE_PNG */ +} /* namespace lodepng */ +#endif /*LODEPNG_COMPILE_CPP*/ diff --git a/Lodepng-Source/lodepng.h b/Lodepng-Source/lodepng.h new file mode 100644 index 0000000..476a206 --- /dev/null +++ b/Lodepng-Source/lodepng.h @@ -0,0 +1,1930 @@ +/* +LodePNG version 20190210 + +Copyright (c) 2005-2019 Lode Vandevenne + +This software is provided 'as-is', without any express or implied +warranty. In no event will the authors be held liable for any damages +arising from the use of this software. + +Permission is granted to anyone to use this software for any purpose, +including commercial applications, and to alter it and redistribute it +freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + + 3. This notice may not be removed or altered from any source + distribution. +*/ + +#ifndef LODEPNG_H +#define LODEPNG_H + +#include /*for size_t*/ + +extern const char* LODEPNG_VERSION_STRING; + +/* +The following #defines are used to create code sections. They can be disabled +to disable code sections, which can give faster compile time and smaller binary. +The "NO_COMPILE" defines are designed to be used to pass as defines to the +compiler command to disable them without modifying this header, e.g. +-DLODEPNG_NO_COMPILE_ZLIB for gcc. +In addition to those below, you can also define LODEPNG_NO_COMPILE_CRC to +allow implementing a custom lodepng_crc32. +*/ +/*deflate & zlib. If disabled, you must specify alternative zlib functions in +the custom_zlib field of the compress and decompress settings*/ +#ifndef LODEPNG_NO_COMPILE_ZLIB +#define LODEPNG_COMPILE_ZLIB +#endif + +/*png encoder and png decoder*/ +#ifndef LODEPNG_NO_COMPILE_PNG +#define LODEPNG_COMPILE_PNG +#endif + +/*deflate&zlib decoder and png decoder*/ +#ifndef LODEPNG_NO_COMPILE_DECODER +#define LODEPNG_COMPILE_DECODER +#endif + +/*deflate&zlib encoder and png encoder*/ +#ifndef LODEPNG_NO_COMPILE_ENCODER +#define LODEPNG_COMPILE_ENCODER +#endif + +/*the optional built in harddisk file loading and saving functions*/ +#ifndef LODEPNG_NO_COMPILE_DISK +#define LODEPNG_COMPILE_DISK +#endif + +/*support for chunks other than IHDR, IDAT, PLTE, tRNS, IEND: ancillary and unknown chunks*/ +#ifndef LODEPNG_NO_COMPILE_ANCILLARY_CHUNKS +#define LODEPNG_COMPILE_ANCILLARY_CHUNKS +#endif + +/*ability to convert error numerical codes to English text string*/ +#ifndef LODEPNG_NO_COMPILE_ERROR_TEXT +#define LODEPNG_COMPILE_ERROR_TEXT +#endif + +/*Compile the default allocators (C's free, malloc and realloc). If you disable this, +you can define the functions lodepng_free, lodepng_malloc and lodepng_realloc in your +source files with custom allocators.*/ +#ifndef LODEPNG_NO_COMPILE_ALLOCATORS +#define LODEPNG_COMPILE_ALLOCATORS +#endif + +/*compile the C++ version (you can disable the C++ wrapper here even when compiling for C++)*/ +#ifdef __cplusplus +#ifndef LODEPNG_NO_COMPILE_CPP +#define LODEPNG_COMPILE_CPP +#endif +#endif + +#ifdef LODEPNG_COMPILE_CPP +#include +#include +#endif /*LODEPNG_COMPILE_CPP*/ + +#ifdef LODEPNG_COMPILE_PNG +/*The PNG color types (also used for raw).*/ +typedef enum LodePNGColorType { + LCT_GREY = 0, /*grayscale: 1,2,4,8,16 bit*/ + LCT_RGB = 2, /*RGB: 8,16 bit*/ + LCT_PALETTE = 3, /*palette: 1,2,4,8 bit*/ + LCT_GREY_ALPHA = 4, /*grayscale with alpha: 8,16 bit*/ + LCT_RGBA = 6 /*RGB with alpha: 8,16 bit*/ +} LodePNGColorType; + +#ifdef LODEPNG_COMPILE_DECODER +/* +Converts PNG data in memory to raw pixel data. +out: Output parameter. Pointer to buffer that will contain the raw pixel data. + After decoding, its size is w * h * (bytes per pixel) bytes larger than + initially. Bytes per pixel depends on colortype and bitdepth. + Must be freed after usage with free(*out). + Note: for 16-bit per channel colors, uses big endian format like PNG does. +w: Output parameter. Pointer to width of pixel data. +h: Output parameter. Pointer to height of pixel data. +in: Memory buffer with the PNG file. +insize: size of the in buffer. +colortype: the desired color type for the raw output image. See explanation on PNG color types. +bitdepth: the desired bit depth for the raw output image. See explanation on PNG color types. +Return value: LodePNG error code (0 means no error). +*/ +unsigned lodepng_decode_memory(unsigned char** out, unsigned* w, unsigned* h, + const unsigned char* in, size_t insize, + LodePNGColorType colortype, unsigned bitdepth); + +/*Same as lodepng_decode_memory, but always decodes to 32-bit RGBA raw image*/ +unsigned lodepng_decode32(unsigned char** out, unsigned* w, unsigned* h, + const unsigned char* in, size_t insize); + +/*Same as lodepng_decode_memory, but always decodes to 24-bit RGB raw image*/ +unsigned lodepng_decode24(unsigned char** out, unsigned* w, unsigned* h, + const unsigned char* in, size_t insize); + +#ifdef LODEPNG_COMPILE_DISK +/* +Load PNG from disk, from file with given name. +Same as the other decode functions, but instead takes a filename as input. +*/ +unsigned lodepng_decode_file(unsigned char** out, unsigned* w, unsigned* h, + const char* filename, + LodePNGColorType colortype, unsigned bitdepth); + +/*Same as lodepng_decode_file, but always decodes to 32-bit RGBA raw image.*/ +unsigned lodepng_decode32_file(unsigned char** out, unsigned* w, unsigned* h, + const char* filename); + +/*Same as lodepng_decode_file, but always decodes to 24-bit RGB raw image.*/ +unsigned lodepng_decode24_file(unsigned char** out, unsigned* w, unsigned* h, + const char* filename); +#endif /*LODEPNG_COMPILE_DISK*/ +#endif /*LODEPNG_COMPILE_DECODER*/ + + +#ifdef LODEPNG_COMPILE_ENCODER +/* +Converts raw pixel data into a PNG image in memory. The colortype and bitdepth + of the output PNG image cannot be chosen, they are automatically determined + by the colortype, bitdepth and content of the input pixel data. + Note: for 16-bit per channel colors, needs big endian format like PNG does. +out: Output parameter. Pointer to buffer that will contain the PNG image data. + Must be freed after usage with free(*out). +outsize: Output parameter. Pointer to the size in bytes of the out buffer. +image: The raw pixel data to encode. The size of this buffer should be + w * h * (bytes per pixel), bytes per pixel depends on colortype and bitdepth. +w: width of the raw pixel data in pixels. +h: height of the raw pixel data in pixels. +colortype: the color type of the raw input image. See explanation on PNG color types. +bitdepth: the bit depth of the raw input image. See explanation on PNG color types. +Return value: LodePNG error code (0 means no error). +*/ +unsigned lodepng_encode_memory(unsigned char** out, size_t* outsize, + const unsigned char* image, unsigned w, unsigned h, + LodePNGColorType colortype, unsigned bitdepth); + +/*Same as lodepng_encode_memory, but always encodes from 32-bit RGBA raw image.*/ +unsigned lodepng_encode32(unsigned char** out, size_t* outsize, + const unsigned char* image, unsigned w, unsigned h); + +/*Same as lodepng_encode_memory, but always encodes from 24-bit RGB raw image.*/ +unsigned lodepng_encode24(unsigned char** out, size_t* outsize, + const unsigned char* image, unsigned w, unsigned h); + +#ifdef LODEPNG_COMPILE_DISK +/* +Converts raw pixel data into a PNG file on disk. +Same as the other encode functions, but instead takes a filename as output. +NOTE: This overwrites existing files without warning! +*/ +unsigned lodepng_encode_file(const char* filename, + const unsigned char* image, unsigned w, unsigned h, + LodePNGColorType colortype, unsigned bitdepth); + +/*Same as lodepng_encode_file, but always encodes from 32-bit RGBA raw image.*/ +unsigned lodepng_encode32_file(const char* filename, + const unsigned char* image, unsigned w, unsigned h); + +/*Same as lodepng_encode_file, but always encodes from 24-bit RGB raw image.*/ +unsigned lodepng_encode24_file(const char* filename, + const unsigned char* image, unsigned w, unsigned h); +#endif /*LODEPNG_COMPILE_DISK*/ +#endif /*LODEPNG_COMPILE_ENCODER*/ + + +#ifdef LODEPNG_COMPILE_CPP +namespace lodepng { +#ifdef LODEPNG_COMPILE_DECODER +/*Same as lodepng_decode_memory, but decodes to an std::vector. The colortype +is the format to output the pixels to. Default is RGBA 8-bit per channel.*/ +unsigned decode(std::vector& out, unsigned& w, unsigned& h, + const unsigned char* in, size_t insize, + LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); +unsigned decode(std::vector& out, unsigned& w, unsigned& h, + const std::vector& in, + LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); +#ifdef LODEPNG_COMPILE_DISK +/* +Converts PNG file from disk to raw pixel data in memory. +Same as the other decode functions, but instead takes a filename as input. +*/ +unsigned decode(std::vector& out, unsigned& w, unsigned& h, + const std::string& filename, + LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); +#endif /* LODEPNG_COMPILE_DISK */ +#endif /* LODEPNG_COMPILE_DECODER */ + +#ifdef LODEPNG_COMPILE_ENCODER +/*Same as lodepng_encode_memory, but encodes to an std::vector. colortype +is that of the raw input data. The output PNG color type will be auto chosen.*/ +unsigned encode(std::vector& out, + const unsigned char* in, unsigned w, unsigned h, + LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); +unsigned encode(std::vector& out, + const std::vector& in, unsigned w, unsigned h, + LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); +#ifdef LODEPNG_COMPILE_DISK +/* +Converts 32-bit RGBA raw pixel data into a PNG file on disk. +Same as the other encode functions, but instead takes a filename as output. +NOTE: This overwrites existing files without warning! +*/ +unsigned encode(const std::string& filename, + const unsigned char* in, unsigned w, unsigned h, + LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); +unsigned encode(const std::string& filename, + const std::vector& in, unsigned w, unsigned h, + LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8); +#endif /* LODEPNG_COMPILE_DISK */ +#endif /* LODEPNG_COMPILE_ENCODER */ +} /* namespace lodepng */ +#endif /*LODEPNG_COMPILE_CPP*/ +#endif /*LODEPNG_COMPILE_PNG*/ + +#ifdef LODEPNG_COMPILE_ERROR_TEXT +/*Returns an English description of the numerical error code.*/ +const char* lodepng_error_text(unsigned code); +#endif /*LODEPNG_COMPILE_ERROR_TEXT*/ + +#ifdef LODEPNG_COMPILE_DECODER +/*Settings for zlib decompression*/ +typedef struct LodePNGDecompressSettings LodePNGDecompressSettings; +struct LodePNGDecompressSettings { + /* Check LodePNGDecoderSettings for more ignorable errors such as ignore_crc */ + unsigned ignore_adler32; /*if 1, continue and don't give an error message if the Adler32 checksum is corrupted*/ + + /*use custom zlib decoder instead of built in one (default: null)*/ + unsigned (*custom_zlib)(unsigned char**, size_t*, + const unsigned char*, size_t, + const LodePNGDecompressSettings*); + /*use custom deflate decoder instead of built in one (default: null) + if custom_zlib is used, custom_deflate is ignored since only the built in + zlib function will call custom_deflate*/ + unsigned (*custom_inflate)(unsigned char**, size_t*, + const unsigned char*, size_t, + const LodePNGDecompressSettings*); + + const void* custom_context; /*optional custom settings for custom functions*/ +}; + +extern const LodePNGDecompressSettings lodepng_default_decompress_settings; +void lodepng_decompress_settings_init(LodePNGDecompressSettings* settings); +#endif /*LODEPNG_COMPILE_DECODER*/ + +#ifdef LODEPNG_COMPILE_ENCODER +/* +Settings for zlib compression. Tweaking these settings tweaks the balance +between speed and compression ratio. +*/ +typedef struct LodePNGCompressSettings LodePNGCompressSettings; +struct LodePNGCompressSettings /*deflate = compress*/ { + /*LZ77 related settings*/ + unsigned btype; /*the block type for LZ (0, 1, 2 or 3, see zlib standard). Should be 2 for proper compression.*/ + unsigned use_lz77; /*whether or not to use LZ77. Should be 1 for proper compression.*/ + unsigned windowsize; /*must be a power of two <= 32768. higher compresses more but is slower. Default value: 2048.*/ + unsigned minmatch; /*mininum lz77 length. 3 is normally best, 6 can be better for some PNGs. Default: 0*/ + unsigned nicematch; /*stop searching if >= this length found. Set to 258 for best compression. Default: 128*/ + unsigned lazymatching; /*use lazy matching: better compression but a bit slower. Default: true*/ + + /*use custom zlib encoder instead of built in one (default: null)*/ + unsigned (*custom_zlib)(unsigned char**, size_t*, + const unsigned char*, size_t, + const LodePNGCompressSettings*); + /*use custom deflate encoder instead of built in one (default: null) + if custom_zlib is used, custom_deflate is ignored since only the built in + zlib function will call custom_deflate*/ + unsigned (*custom_deflate)(unsigned char**, size_t*, + const unsigned char*, size_t, + const LodePNGCompressSettings*); + + const void* custom_context; /*optional custom settings for custom functions*/ +}; + +extern const LodePNGCompressSettings lodepng_default_compress_settings; +void lodepng_compress_settings_init(LodePNGCompressSettings* settings); +#endif /*LODEPNG_COMPILE_ENCODER*/ + +#ifdef LODEPNG_COMPILE_PNG +/* +Color mode of an image. Contains all information required to decode the pixel +bits to RGBA colors. This information is the same as used in the PNG file +format, and is used both for PNG and raw image data in LodePNG. +*/ +typedef struct LodePNGColorMode { + /*header (IHDR)*/ + LodePNGColorType colortype; /*color type, see PNG standard or documentation further in this header file*/ + unsigned bitdepth; /*bits per sample, see PNG standard or documentation further in this header file*/ + + /* + palette (PLTE and tRNS) + + Dynamically allocated with the colors of the palette, including alpha. + When encoding a PNG, to store your colors in the palette of the LodePNGColorMode, first use + lodepng_palette_clear, then for each color use lodepng_palette_add. + If you encode an image without alpha with palette, don't forget to put value 255 in each A byte of the palette. + + When decoding, by default you can ignore this palette, since LodePNG already + fills the palette colors in the pixels of the raw RGBA output. + + The palette is only supported for color type 3. + */ + unsigned char* palette; /*palette in RGBARGBA... order. When allocated, must be either 0, or have size 1024*/ + size_t palettesize; /*palette size in number of colors (amount of bytes is 4 * palettesize)*/ + + /* + transparent color key (tRNS) + + This color uses the same bit depth as the bitdepth value in this struct, which can be 1-bit to 16-bit. + For grayscale PNGs, r, g and b will all 3 be set to the same. + + When decoding, by default you can ignore this information, since LodePNG sets + pixels with this key to transparent already in the raw RGBA output. + + The color key is only supported for color types 0 and 2. + */ + unsigned key_defined; /*is a transparent color key given? 0 = false, 1 = true*/ + unsigned key_r; /*red/grayscale component of color key*/ + unsigned key_g; /*green component of color key*/ + unsigned key_b; /*blue component of color key*/ +} LodePNGColorMode; + +/*init, cleanup and copy functions to use with this struct*/ +void lodepng_color_mode_init(LodePNGColorMode* info); +void lodepng_color_mode_cleanup(LodePNGColorMode* info); +/*return value is error code (0 means no error)*/ +unsigned lodepng_color_mode_copy(LodePNGColorMode* dest, const LodePNGColorMode* source); +/* Makes a temporary LodePNGColorMode that does not need cleanup (no palette) */ +LodePNGColorMode lodepng_color_mode_make(LodePNGColorType colortype, unsigned bitdepth); + +void lodepng_palette_clear(LodePNGColorMode* info); +/*add 1 color to the palette*/ +unsigned lodepng_palette_add(LodePNGColorMode* info, + unsigned char r, unsigned char g, unsigned char b, unsigned char a); + +/*get the total amount of bits per pixel, based on colortype and bitdepth in the struct*/ +unsigned lodepng_get_bpp(const LodePNGColorMode* info); +/*get the amount of color channels used, based on colortype in the struct. +If a palette is used, it counts as 1 channel.*/ +unsigned lodepng_get_channels(const LodePNGColorMode* info); +/*is it a grayscale type? (only colortype 0 or 4)*/ +unsigned lodepng_is_greyscale_type(const LodePNGColorMode* info); +/*has it got an alpha channel? (only colortype 2 or 6)*/ +unsigned lodepng_is_alpha_type(const LodePNGColorMode* info); +/*has it got a palette? (only colortype 3)*/ +unsigned lodepng_is_palette_type(const LodePNGColorMode* info); +/*only returns true if there is a palette and there is a value in the palette with alpha < 255. +Loops through the palette to check this.*/ +unsigned lodepng_has_palette_alpha(const LodePNGColorMode* info); +/* +Check if the given color info indicates the possibility of having non-opaque pixels in the PNG image. +Returns true if the image can have translucent or invisible pixels (it still be opaque if it doesn't use such pixels). +Returns false if the image can only have opaque pixels. +In detail, it returns true only if it's a color type with alpha, or has a palette with non-opaque values, +or if "key_defined" is true. +*/ +unsigned lodepng_can_have_alpha(const LodePNGColorMode* info); +/*Returns the byte size of a raw image buffer with given width, height and color mode*/ +size_t lodepng_get_raw_size(unsigned w, unsigned h, const LodePNGColorMode* color); + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS +/*The information of a Time chunk in PNG.*/ +typedef struct LodePNGTime { + unsigned year; /*2 bytes used (0-65535)*/ + unsigned month; /*1-12*/ + unsigned day; /*1-31*/ + unsigned hour; /*0-23*/ + unsigned minute; /*0-59*/ + unsigned second; /*0-60 (to allow for leap seconds)*/ +} LodePNGTime; +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + +/*Information about the PNG image, except pixels, width and height.*/ +typedef struct LodePNGInfo { + /*header (IHDR), palette (PLTE) and transparency (tRNS) chunks*/ + unsigned compression_method;/*compression method of the original file. Always 0.*/ + unsigned filter_method; /*filter method of the original file*/ + unsigned interlace_method; /*interlace method of the original file: 0=none, 1=Adam7*/ + LodePNGColorMode color; /*color type and bits, palette and transparency of the PNG file*/ + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + /* + Suggested background color chunk (bKGD) + + This uses the same color mode and bit depth as the PNG (except no alpha channel), + with values truncated to the bit depth in the unsigned integer. + + For grayscale and palette PNGs, the value is stored in background_r. The values + in background_g and background_b are then unused. + + So when decoding, you may get these in a different color mode than the one you requested + for the raw pixels. + + When encoding with auto_convert, you must use the color model defined in info_png.color for + these values. The encoder normally ignores info_png.color when auto_convert is on, but will + use it to interpret these values (and convert copies of them to its chosen color model). + + When encoding, avoid setting this to an expensive color, such as a non-gray value + when the image is gray, or the compression will be worse since it will be forced to + write the PNG with a more expensive color mode (when auto_convert is on). + + The decoder does not use this background color to edit the color of pixels. This is a + completely optional metadata feature. + */ + unsigned background_defined; /*is a suggested background color given?*/ + unsigned background_r; /*red/gray/palette component of suggested background color*/ + unsigned background_g; /*green component of suggested background color*/ + unsigned background_b; /*blue component of suggested background color*/ + + /* + non-international text chunks (tEXt and zTXt) + + The char** arrays each contain num strings. The actual messages are in + text_strings, while text_keys are keywords that give a short description what + the actual text represents, e.g. Title, Author, Description, or anything else. + + All the string fields below including keys, names and language tags are null terminated. + The PNG specification uses null characters for the keys, names and tags, and forbids null + characters to appear in the main text which is why we can use null termination everywhere here. + + A keyword is minimum 1 character and maximum 79 characters long. It's + discouraged to use a single line length longer than 79 characters for texts. + + Don't allocate these text buffers yourself. Use the init/cleanup functions + correctly and use lodepng_add_text and lodepng_clear_text. + */ + size_t text_num; /*the amount of texts in these char** buffers (there may be more texts in itext)*/ + char** text_keys; /*the keyword of a text chunk (e.g. "Comment")*/ + char** text_strings; /*the actual text*/ + + /* + international text chunks (iTXt) + Similar to the non-international text chunks, but with additional strings + "langtags" and "transkeys". + */ + size_t itext_num; /*the amount of international texts in this PNG*/ + char** itext_keys; /*the English keyword of the text chunk (e.g. "Comment")*/ + char** itext_langtags; /*language tag for this text's language, ISO/IEC 646 string, e.g. ISO 639 language tag*/ + char** itext_transkeys; /*keyword translated to the international language - UTF-8 string*/ + char** itext_strings; /*the actual international text - UTF-8 string*/ + + /*time chunk (tIME)*/ + unsigned time_defined; /*set to 1 to make the encoder generate a tIME chunk*/ + LodePNGTime time; + + /*phys chunk (pHYs)*/ + unsigned phys_defined; /*if 0, there is no pHYs chunk and the values below are undefined, if 1 else there is one*/ + unsigned phys_x; /*pixels per unit in x direction*/ + unsigned phys_y; /*pixels per unit in y direction*/ + unsigned phys_unit; /*may be 0 (unknown unit) or 1 (metre)*/ + + /* + Color profile related chunks: gAMA, cHRM, sRGB, iCPP + + LodePNG does not apply any color conversions on pixels in the encoder or decoder and does not interpret these color + profile values. It merely passes on the information. If you wish to use color profiles and convert colors, please + use these values with a color management library. + + See the PNG, ICC and sRGB specifications for more information about the meaning of these values. + */ + + /* gAMA chunk: optional, overridden by sRGB or iCCP if those are present. */ + unsigned gama_defined; /* Whether a gAMA chunk is present (0 = not present, 1 = present). */ + unsigned gama_gamma; /* Gamma exponent times 100000 */ + + /* cHRM chunk: optional, overridden by sRGB or iCCP if those are present. */ + unsigned chrm_defined; /* Whether a cHRM chunk is present (0 = not present, 1 = present). */ + unsigned chrm_white_x; /* White Point x times 100000 */ + unsigned chrm_white_y; /* White Point y times 100000 */ + unsigned chrm_red_x; /* Red x times 100000 */ + unsigned chrm_red_y; /* Red y times 100000 */ + unsigned chrm_green_x; /* Green x times 100000 */ + unsigned chrm_green_y; /* Green y times 100000 */ + unsigned chrm_blue_x; /* Blue x times 100000 */ + unsigned chrm_blue_y; /* Blue y times 100000 */ + + /* + sRGB chunk: optional. May not appear at the same time as iCCP. + If gAMA is also present gAMA must contain value 45455. + If cHRM is also present cHRM must contain respectively 31270,32900,64000,33000,30000,60000,15000,6000. + */ + unsigned srgb_defined; /* Whether an sRGB chunk is present (0 = not present, 1 = present). */ + unsigned srgb_intent; /* Rendering intent: 0=perceptual, 1=rel. colorimetric, 2=saturation, 3=abs. colorimetric */ + + /* + iCCP chunk: optional. May not appear at the same time as sRGB. + + LodePNG does not parse or use the ICC profile (except its color space header field for an edge case), a + separate library to handle the ICC data (not included in LodePNG) format is needed to use it for color + management and conversions. + + For encoding, if iCCP is present, gAMA and cHRM are recommended to be added as well with values that match the ICC + profile as closely as possible, if you wish to do this you should provide the correct values for gAMA and cHRM and + enable their '_defined' flags since LodePNG will not automatically compute them from the ICC profile. + + For encoding, the ICC profile is required by the PNG specification to be an "RGB" profile for non-gray + PNG color types and a "GRAY" profile for gray PNG color types. If you disable auto_convert, you must ensure + the ICC profile type matches your requested color type, else the encoder gives an error. If auto_convert is + enabled (the default), and the ICC profile is not a good match for the pixel data, this will result in an encoder + error if the pixel data has non-gray pixels for a GRAY profile, or a silent less-optimal compression of the pixel + data if the pixels could be encoded as grayscale but the ICC profile is RGB. + + To avoid this do not set an ICC profile in the image unless there is a good reason for it, and when doing so + make sure you compute it carefully to avoid the above problems. + */ + unsigned iccp_defined; /* Whether an iCCP chunk is present (0 = not present, 1 = present). */ + char* iccp_name; /* Null terminated string with profile name, 1-79 bytes */ + /* + The ICC profile in iccp_profile_size bytes. + Don't allocate this buffer yourself. Use the init/cleanup functions + correctly and use lodepng_set_icc and lodepng_clear_icc. + */ + unsigned char* iccp_profile; + unsigned iccp_profile_size; /* The size of iccp_profile in bytes */ + + /* End of color profile related chunks */ + + + /* + unknown chunks: chunks not known by LodePNG, passed on byte for byte. + + There are 3 buffers, one for each position in the PNG where unknown chunks can appear. + Each buffer contains all unknown chunks for that position consecutively. + The 3 positions are: + 0: between IHDR and PLTE, 1: between PLTE and IDAT, 2: between IDAT and IEND. + + For encoding, do not store critical chunks or known chunks that are enabled with a "_defined" flag + above in here, since the encoder will blindly follow this and could then encode an invalid PNG file + (such as one with two IHDR chunks or the disallowed combination of sRGB with iCCP). But do use + this if you wish to store an ancillary chunk that is not supported by LodePNG (such as sPLT or hIST), + or any non-standard PNG chunk. + + Do not allocate or traverse this data yourself. Use the chunk traversing functions declared + later, such as lodepng_chunk_next and lodepng_chunk_append, to read/write this struct. + */ + unsigned char* unknown_chunks_data[3]; + size_t unknown_chunks_size[3]; /*size in bytes of the unknown chunks, given for protection*/ +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ +} LodePNGInfo; + +/*init, cleanup and copy functions to use with this struct*/ +void lodepng_info_init(LodePNGInfo* info); +void lodepng_info_cleanup(LodePNGInfo* info); +/*return value is error code (0 means no error)*/ +unsigned lodepng_info_copy(LodePNGInfo* dest, const LodePNGInfo* source); + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS +unsigned lodepng_add_text(LodePNGInfo* info, const char* key, const char* str); /*push back both texts at once*/ +void lodepng_clear_text(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/ + +unsigned lodepng_add_itext(LodePNGInfo* info, const char* key, const char* langtag, + const char* transkey, const char* str); /*push back the 4 texts of 1 chunk at once*/ +void lodepng_clear_itext(LodePNGInfo* info); /*use this to clear the itexts again after you filled them in*/ + +/*replaces if exists*/ +unsigned lodepng_set_icc(LodePNGInfo* info, const char* name, const unsigned char* profile, unsigned profile_size); +void lodepng_clear_icc(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/ +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ + +/* +Converts raw buffer from one color type to another color type, based on +LodePNGColorMode structs to describe the input and output color type. +See the reference manual at the end of this header file to see which color conversions are supported. +return value = LodePNG error code (0 if all went ok, an error if the conversion isn't supported) +The out buffer must have size (w * h * bpp + 7) / 8, where bpp is the bits per pixel +of the output color type (lodepng_get_bpp). +For < 8 bpp images, there should not be padding bits at the end of scanlines. +For 16-bit per channel colors, uses big endian format like PNG does. +Return value is LodePNG error code +*/ +unsigned lodepng_convert(unsigned char* out, const unsigned char* in, + const LodePNGColorMode* mode_out, const LodePNGColorMode* mode_in, + unsigned w, unsigned h); + +#ifdef LODEPNG_COMPILE_DECODER +/* +Settings for the decoder. This contains settings for the PNG and the Zlib +decoder, but not the Info settings from the Info structs. +*/ +typedef struct LodePNGDecoderSettings { + LodePNGDecompressSettings zlibsettings; /*in here is the setting to ignore Adler32 checksums*/ + + /* Check LodePNGDecompressSettings for more ignorable errors such as ignore_adler32 */ + unsigned ignore_crc; /*ignore CRC checksums*/ + unsigned ignore_critical; /*ignore unknown critical chunks*/ + unsigned ignore_end; /*ignore issues at end of file if possible (missing IEND chunk, too large chunk, ...)*/ + /* TODO: make a system involving warnings with levels and a strict mode instead. Other potentially recoverable + errors: srgb rendering intent value, size of content of ancillary chunks, more than 79 characters for some + strings, placement/combination rules for ancillary chunks, crc of unknown chunks, allowed characters + in string keys, etc... */ + + unsigned color_convert; /*whether to convert the PNG to the color type you want. Default: yes*/ + +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + unsigned read_text_chunks; /*if false but remember_unknown_chunks is true, they're stored in the unknown chunks*/ + /*store all bytes from unknown chunks in the LodePNGInfo (off by default, useful for a png editor)*/ + unsigned remember_unknown_chunks; +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ +} LodePNGDecoderSettings; + +void lodepng_decoder_settings_init(LodePNGDecoderSettings* settings); +#endif /*LODEPNG_COMPILE_DECODER*/ + +#ifdef LODEPNG_COMPILE_ENCODER +/*automatically use color type with less bits per pixel if losslessly possible. Default: AUTO*/ +typedef enum LodePNGFilterStrategy { + /*every filter at zero*/ + LFS_ZERO, + /*Use filter that gives minimum sum, as described in the official PNG filter heuristic.*/ + LFS_MINSUM, + /*Use the filter type that gives smallest Shannon entropy for this scanline. Depending + on the image, this is better or worse than minsum.*/ + LFS_ENTROPY, + /* + Brute-force-search PNG filters by compressing each filter for each scanline. + Experimental, very slow, and only rarely gives better compression than MINSUM. + */ + LFS_BRUTE_FORCE, + /*use predefined_filters buffer: you specify the filter type for each scanline*/ + LFS_PREDEFINED +} LodePNGFilterStrategy; + +/*Gives characteristics about the integer RGBA colors of the image (count, alpha channel usage, bit depth, ...), +which helps decide which color model to use for encoding. +Used internally by default if "auto_convert" is enabled. Public because it's useful for custom algorithms. +NOTE: This is not related to the ICC color profile, search "iccp_profile" instead to find the ICC/chromacity/... +fields in this header file.*/ +typedef struct LodePNGColorProfile { + unsigned colored; /*not grayscale*/ + unsigned key; /*image is not opaque and color key is possible instead of full alpha*/ + unsigned short key_r; /*key values, always as 16-bit, in 8-bit case the byte is duplicated, e.g. 65535 means 255*/ + unsigned short key_g; + unsigned short key_b; + unsigned alpha; /*image is not opaque and alpha channel or alpha palette required*/ + unsigned numcolors; /*amount of colors, up to 257. Not valid if bits == 16.*/ + unsigned char palette[1024]; /*Remembers up to the first 256 RGBA colors, in no particular order*/ + unsigned bits; /*bits per channel (not for palette). 1,2 or 4 for grayscale only. 16 if 16-bit per channel required.*/ + size_t numpixels; +} LodePNGColorProfile; + +void lodepng_color_profile_init(LodePNGColorProfile* profile); + +/*Get a LodePNGColorProfile of the image. The profile must already have been inited. +NOTE: This is not related to the ICC color profile, search "iccp_profile" instead to find the ICC/chromacity/... +fields in this header file.*/ +unsigned lodepng_get_color_profile(LodePNGColorProfile* profile, + const unsigned char* image, unsigned w, unsigned h, + const LodePNGColorMode* mode_in); +/*The function LodePNG uses internally to decide the PNG color with auto_convert. +Chooses an optimal color model, e.g. gray if only gray pixels, palette if < 256 colors, ...*/ +unsigned lodepng_auto_choose_color(LodePNGColorMode* mode_out, + const unsigned char* image, unsigned w, unsigned h, + const LodePNGColorMode* mode_in); + +/*Settings for the encoder.*/ +typedef struct LodePNGEncoderSettings { + LodePNGCompressSettings zlibsettings; /*settings for the zlib encoder, such as window size, ...*/ + + unsigned auto_convert; /*automatically choose output PNG color type. Default: true*/ + + /*If true, follows the official PNG heuristic: if the PNG uses a palette or lower than + 8 bit depth, set all filters to zero. Otherwise use the filter_strategy. Note that to + completely follow the official PNG heuristic, filter_palette_zero must be true and + filter_strategy must be LFS_MINSUM*/ + unsigned filter_palette_zero; + /*Which filter strategy to use when not using zeroes due to filter_palette_zero. + Set filter_palette_zero to 0 to ensure always using your chosen strategy. Default: LFS_MINSUM*/ + LodePNGFilterStrategy filter_strategy; + /*used if filter_strategy is LFS_PREDEFINED. In that case, this must point to a buffer with + the same length as the amount of scanlines in the image, and each value must <= 5. You + have to cleanup this buffer, LodePNG will never free it. Don't forget that filter_palette_zero + must be set to 0 to ensure this is also used on palette or low bitdepth images.*/ + const unsigned char* predefined_filters; + + /*force creating a PLTE chunk if colortype is 2 or 6 (= a suggested palette). + If colortype is 3, PLTE is _always_ created.*/ + unsigned force_palette; +#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS + /*add LodePNG identifier and version as a text chunk, for debugging*/ + unsigned add_id; + /*encode text chunks as zTXt chunks instead of tEXt chunks, and use compression in iTXt chunks*/ + unsigned text_compression; +#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/ +} LodePNGEncoderSettings; + +void lodepng_encoder_settings_init(LodePNGEncoderSettings* settings); +#endif /*LODEPNG_COMPILE_ENCODER*/ + + +#if defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) +/*The settings, state and information for extended encoding and decoding.*/ +typedef struct LodePNGState { +#ifdef LODEPNG_COMPILE_DECODER + LodePNGDecoderSettings decoder; /*the decoding settings*/ +#endif /*LODEPNG_COMPILE_DECODER*/ +#ifdef LODEPNG_COMPILE_ENCODER + LodePNGEncoderSettings encoder; /*the encoding settings*/ +#endif /*LODEPNG_COMPILE_ENCODER*/ + LodePNGColorMode info_raw; /*specifies the format in which you would like to get the raw pixel buffer*/ + LodePNGInfo info_png; /*info of the PNG image obtained after decoding*/ + unsigned error; +#ifdef LODEPNG_COMPILE_CPP + /* For the lodepng::State subclass. */ + virtual ~LodePNGState(){} +#endif +} LodePNGState; + +/*init, cleanup and copy functions to use with this struct*/ +void lodepng_state_init(LodePNGState* state); +void lodepng_state_cleanup(LodePNGState* state); +void lodepng_state_copy(LodePNGState* dest, const LodePNGState* source); +#endif /* defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) */ + +#ifdef LODEPNG_COMPILE_DECODER +/* +Same as lodepng_decode_memory, but uses a LodePNGState to allow custom settings and +getting much more information about the PNG image and color mode. +*/ +unsigned lodepng_decode(unsigned char** out, unsigned* w, unsigned* h, + LodePNGState* state, + const unsigned char* in, size_t insize); + +/* +Read the PNG header, but not the actual data. This returns only the information +that is in the IHDR chunk of the PNG, such as width, height and color type. The +information is placed in the info_png field of the LodePNGState. +*/ +unsigned lodepng_inspect(unsigned* w, unsigned* h, + LodePNGState* state, + const unsigned char* in, size_t insize); +#endif /*LODEPNG_COMPILE_DECODER*/ + +/* +Reads one metadata chunk (other than IHDR) of the PNG file and outputs what it +read in the state. Returns error code on failure. +Use lodepng_inspect first with a new state, then e.g. lodepng_chunk_find_const +to find the desired chunk type, and if non null use lodepng_inspect_chunk (with +chunk_pointer - start_of_file as pos). +Supports most metadata chunks from the PNG standard (gAMA, bKGD, tEXt, ...). +Ignores unsupported, unknown, non-metadata or IHDR chunks (without error). +Requirements: &in[pos] must point to start of a chunk, must use regular +lodepng_inspect first since format of most other chunks depends on IHDR, and if +there is a PLTE chunk, that one must be inspected before tRNS or bKGD. +*/ +unsigned lodepng_inspect_chunk(LodePNGState* state, size_t pos, + const unsigned char* in, size_t insize); + +#ifdef LODEPNG_COMPILE_ENCODER +/*This function allocates the out buffer with standard malloc and stores the size in *outsize.*/ +unsigned lodepng_encode(unsigned char** out, size_t* outsize, + const unsigned char* image, unsigned w, unsigned h, + LodePNGState* state); +#endif /*LODEPNG_COMPILE_ENCODER*/ + +/* +The lodepng_chunk functions are normally not needed, except to traverse the +unknown chunks stored in the LodePNGInfo struct, or add new ones to it. +It also allows traversing the chunks of an encoded PNG file yourself. + +The chunk pointer always points to the beginning of the chunk itself, that is +the first byte of the 4 length bytes. + +In the PNG file format, chunks have the following format: +-4 bytes length: length of the data of the chunk in bytes (chunk itself is 12 bytes longer) +-4 bytes chunk type (ASCII a-z,A-Z only, see below) +-length bytes of data (may be 0 bytes if length was 0) +-4 bytes of CRC, computed on chunk name + data + +The first chunk starts at the 8th byte of the PNG file, the entire rest of the file +exists out of concatenated chunks with the above format. + +PNG standard chunk ASCII naming conventions: +-First byte: uppercase = critical, lowercase = ancillary +-Second byte: uppercase = public, lowercase = private +-Third byte: must be uppercase +-Fourth byte: uppercase = unsafe to copy, lowercase = safe to copy +*/ + +/* +Gets the length of the data of the chunk. Total chunk length has 12 bytes more. +There must be at least 4 bytes to read from. If the result value is too large, +it may be corrupt data. +*/ +unsigned lodepng_chunk_length(const unsigned char* chunk); + +/*puts the 4-byte type in null terminated string*/ +void lodepng_chunk_type(char type[5], const unsigned char* chunk); + +/*check if the type is the given type*/ +unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type); + +/*0: it's one of the critical chunk types, 1: it's an ancillary chunk (see PNG standard)*/ +unsigned char lodepng_chunk_ancillary(const unsigned char* chunk); + +/*0: public, 1: private (see PNG standard)*/ +unsigned char lodepng_chunk_private(const unsigned char* chunk); + +/*0: the chunk is unsafe to copy, 1: the chunk is safe to copy (see PNG standard)*/ +unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk); + +/*get pointer to the data of the chunk, where the input points to the header of the chunk*/ +unsigned char* lodepng_chunk_data(unsigned char* chunk); +const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk); + +/*returns 0 if the crc is correct, 1 if it's incorrect (0 for OK as usual!)*/ +unsigned lodepng_chunk_check_crc(const unsigned char* chunk); + +/*generates the correct CRC from the data and puts it in the last 4 bytes of the chunk*/ +void lodepng_chunk_generate_crc(unsigned char* chunk); + +/* +Iterate to next chunks, allows iterating through all chunks of the PNG file. +Input must be at the beginning of a chunk (result of a previous lodepng_chunk_next call, +or the 8th byte of a PNG file which always has the first chunk), or alternatively may +point to the first byte of the PNG file (which is not a chunk but the magic header, the +function will then skip over it and return the first real chunk). +Expects at least 8 readable bytes of memory in the input pointer. +Will output pointer to the start of the next chunk or the end of the file if there +is no more chunk after this. Start this process at the 8th byte of the PNG file. +In a non-corrupt PNG file, the last chunk should have name "IEND". +*/ +unsigned char* lodepng_chunk_next(unsigned char* chunk); +const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk); + +/*Finds the first chunk with the given type in the range [chunk, end), or returns NULL if not found.*/ +unsigned char* lodepng_chunk_find(unsigned char* chunk, const unsigned char* end, const char type[5]); +const unsigned char* lodepng_chunk_find_const(const unsigned char* chunk, const unsigned char* end, const char type[5]); + +/* +Appends chunk to the data in out. The given chunk should already have its chunk header. +The out variable and outlength are updated to reflect the new reallocated buffer. +Returns error code (0 if it went ok) +*/ +unsigned lodepng_chunk_append(unsigned char** out, size_t* outlength, const unsigned char* chunk); + +/* +Appends new chunk to out. The chunk to append is given by giving its length, type +and data separately. The type is a 4-letter string. +The out variable and outlength are updated to reflect the new reallocated buffer. +Returne error code (0 if it went ok) +*/ +unsigned lodepng_chunk_create(unsigned char** out, size_t* outlength, unsigned length, + const char* type, const unsigned char* data); + + +/*Calculate CRC32 of buffer*/ +unsigned lodepng_crc32(const unsigned char* buf, size_t len); +#endif /*LODEPNG_COMPILE_PNG*/ + + +#ifdef LODEPNG_COMPILE_ZLIB +/* +This zlib part can be used independently to zlib compress and decompress a +buffer. It cannot be used to create gzip files however, and it only supports the +part of zlib that is required for PNG, it does not support dictionaries. +*/ + +#ifdef LODEPNG_COMPILE_DECODER +/*Inflate a buffer. Inflate is the decompression step of deflate. Out buffer must be freed after use.*/ +unsigned lodepng_inflate(unsigned char** out, size_t* outsize, + const unsigned char* in, size_t insize, + const LodePNGDecompressSettings* settings); + +/* +Decompresses Zlib data. Reallocates the out buffer and appends the data. The +data must be according to the zlib specification. +Either, *out must be NULL and *outsize must be 0, or, *out must be a valid +buffer and *outsize its size in bytes. out must be freed by user after usage. +*/ +unsigned lodepng_zlib_decompress(unsigned char** out, size_t* outsize, + const unsigned char* in, size_t insize, + const LodePNGDecompressSettings* settings); +#endif /*LODEPNG_COMPILE_DECODER*/ + +#ifdef LODEPNG_COMPILE_ENCODER +/* +Compresses data with Zlib. Reallocates the out buffer and appends the data. +Zlib adds a small header and trailer around the deflate data. +The data is output in the format of the zlib specification. +Either, *out must be NULL and *outsize must be 0, or, *out must be a valid +buffer and *outsize its size in bytes. out must be freed by user after usage. +*/ +unsigned lodepng_zlib_compress(unsigned char** out, size_t* outsize, + const unsigned char* in, size_t insize, + const LodePNGCompressSettings* settings); + +/* +Find length-limited Huffman code for given frequencies. This function is in the +public interface only for tests, it's used internally by lodepng_deflate. +*/ +unsigned lodepng_huffman_code_lengths(unsigned* lengths, const unsigned* frequencies, + size_t numcodes, unsigned maxbitlen); + +/*Compress a buffer with deflate. See RFC 1951. Out buffer must be freed after use.*/ +unsigned lodepng_deflate(unsigned char** out, size_t* outsize, + const unsigned char* in, size_t insize, + const LodePNGCompressSettings* settings); + +#endif /*LODEPNG_COMPILE_ENCODER*/ +#endif /*LODEPNG_COMPILE_ZLIB*/ + +#ifdef LODEPNG_COMPILE_DISK +/* +Load a file from disk into buffer. The function allocates the out buffer, and +after usage you should free it. +out: output parameter, contains pointer to loaded buffer. +outsize: output parameter, size of the allocated out buffer +filename: the path to the file to load +return value: error code (0 means ok) +*/ +unsigned lodepng_load_file(unsigned char** out, size_t* outsize, const char* filename); + +/* +Save a file from buffer to disk. Warning, if it exists, this function overwrites +the file without warning! +buffer: the buffer to write +buffersize: size of the buffer to write +filename: the path to the file to save to +return value: error code (0 means ok) +*/ +unsigned lodepng_save_file(const unsigned char* buffer, size_t buffersize, const char* filename); +#endif /*LODEPNG_COMPILE_DISK*/ + +#ifdef LODEPNG_COMPILE_CPP +/* The LodePNG C++ wrapper uses std::vectors instead of manually allocated memory buffers. */ +namespace lodepng { +#ifdef LODEPNG_COMPILE_PNG +class State : public LodePNGState { + public: + State(); + State(const State& other); + virtual ~State(); + State& operator=(const State& other); +}; + +#ifdef LODEPNG_COMPILE_DECODER +/* Same as other lodepng::decode, but using a State for more settings and information. */ +unsigned decode(std::vector& out, unsigned& w, unsigned& h, + State& state, + const unsigned char* in, size_t insize); +unsigned decode(std::vector& out, unsigned& w, unsigned& h, + State& state, + const std::vector& in); +#endif /*LODEPNG_COMPILE_DECODER*/ + +#ifdef LODEPNG_COMPILE_ENCODER +/* Same as other lodepng::encode, but using a State for more settings and information. */ +unsigned encode(std::vector& out, + const unsigned char* in, unsigned w, unsigned h, + State& state); +unsigned encode(std::vector& out, + const std::vector& in, unsigned w, unsigned h, + State& state); +#endif /*LODEPNG_COMPILE_ENCODER*/ + +#ifdef LODEPNG_COMPILE_DISK +/* +Load a file from disk into an std::vector. +return value: error code (0 means ok) +*/ +unsigned load_file(std::vector& buffer, const std::string& filename); + +/* +Save the binary data in an std::vector to a file on disk. The file is overwritten +without warning. +*/ +unsigned save_file(const std::vector& buffer, const std::string& filename); +#endif /* LODEPNG_COMPILE_DISK */ +#endif /* LODEPNG_COMPILE_PNG */ + +#ifdef LODEPNG_COMPILE_ZLIB +#ifdef LODEPNG_COMPILE_DECODER +/* Zlib-decompress an unsigned char buffer */ +unsigned decompress(std::vector& out, const unsigned char* in, size_t insize, + const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings); + +/* Zlib-decompress an std::vector */ +unsigned decompress(std::vector& out, const std::vector& in, + const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings); +#endif /* LODEPNG_COMPILE_DECODER */ + +#ifdef LODEPNG_COMPILE_ENCODER +/* Zlib-compress an unsigned char buffer */ +unsigned compress(std::vector& out, const unsigned char* in, size_t insize, + const LodePNGCompressSettings& settings = lodepng_default_compress_settings); + +/* Zlib-compress an std::vector */ +unsigned compress(std::vector& out, const std::vector& in, + const LodePNGCompressSettings& settings = lodepng_default_compress_settings); +#endif /* LODEPNG_COMPILE_ENCODER */ +#endif /* LODEPNG_COMPILE_ZLIB */ +} /* namespace lodepng */ +#endif /*LODEPNG_COMPILE_CPP*/ + +/* +TODO: +[.] test if there are no memory leaks or security exploits - done a lot but needs to be checked often +[.] check compatibility with various compilers - done but needs to be redone for every newer version +[X] converting color to 16-bit per channel types +[X] support color profile chunk types (but never let them touch RGB values by default) +[ ] support all public PNG chunk types (almost done except sBIT, sPLT and hIST) +[ ] make sure encoder generates no chunks with size > (2^31)-1 +[ ] partial decoding (stream processing) +[X] let the "isFullyOpaque" function check color keys and transparent palettes too +[X] better name for the variables "codes", "codesD", "codelengthcodes", "clcl" and "lldl" +[ ] allow treating some errors like warnings, when image is recoverable (e.g. 69, 57, 58) +[ ] make warnings like: oob palette, checksum fail, data after iend, wrong/unknown crit chunk, no null terminator in text, ... +[ ] error messages with line numbers (and version) +[ ] errors in state instead of as return code? +[ ] new errors/warnings like suspiciously big decompressed ztxt or iccp chunk +[ ] let the C++ wrapper catch exceptions coming from the standard library and return LodePNG error codes +[ ] allow user to provide custom color conversion functions, e.g. for premultiplied alpha, padding bits or not, ... +[ ] allow user to give data (void*) to custom allocator +[ ] provide alternatives for C library functions not present on some platforms (memcpy, ...) +[ ] rename "grey" to "gray" everywhere since "color" also uses US spelling (keep "grey" copies for backwards compatibility) +*/ + +#endif /*LODEPNG_H inclusion guard*/ + +/* +LodePNG Documentation +--------------------- + +0. table of contents +-------------------- + + 1. about + 1.1. supported features + 1.2. features not supported + 2. C and C++ version + 3. security + 4. decoding + 5. encoding + 6. color conversions + 6.1. PNG color types + 6.2. color conversions + 6.3. padding bits + 6.4. A note about 16-bits per channel and endianness + 7. error values + 8. chunks and PNG editing + 9. compiler support + 10. examples + 10.1. decoder C++ example + 10.2. decoder C example + 11. state settings reference + 12. changes + 13. contact information + + +1. about +-------- + +PNG is a file format to store raster images losslessly with good compression, +supporting different color types and alpha channel. + +LodePNG is a PNG codec according to the Portable Network Graphics (PNG) +Specification (Second Edition) - W3C Recommendation 10 November 2003. + +The specifications used are: + +*) Portable Network Graphics (PNG) Specification (Second Edition): + http://www.w3.org/TR/2003/REC-PNG-20031110 +*) RFC 1950 ZLIB Compressed Data Format version 3.3: + http://www.gzip.org/zlib/rfc-zlib.html +*) RFC 1951 DEFLATE Compressed Data Format Specification ver 1.3: + http://www.gzip.org/zlib/rfc-deflate.html + +The most recent version of LodePNG can currently be found at +http://lodev.org/lodepng/ + +LodePNG works both in C (ISO C90) and C++, with a C++ wrapper that adds +extra functionality. + +LodePNG exists out of two files: +-lodepng.h: the header file for both C and C++ +-lodepng.c(pp): give it the name lodepng.c or lodepng.cpp (or .cc) depending on your usage + +If you want to start using LodePNG right away without reading this doc, get the +examples from the LodePNG website to see how to use it in code, or check the +smaller examples in chapter 13 here. + +LodePNG is simple but only supports the basic requirements. To achieve +simplicity, the following design choices were made: There are no dependencies +on any external library. There are functions to decode and encode a PNG with +a single function call, and extended versions of these functions taking a +LodePNGState struct allowing to specify or get more information. By default +the colors of the raw image are always RGB or RGBA, no matter what color type +the PNG file uses. To read and write files, there are simple functions to +convert the files to/from buffers in memory. + +This all makes LodePNG suitable for loading textures in games, demos and small +programs, ... It's less suitable for full fledged image editors, loading PNGs +over network (it requires all the image data to be available before decoding can +begin), life-critical systems, ... + +1.1. supported features +----------------------- + +The following features are supported by the decoder: + +*) decoding of PNGs with any color type, bit depth and interlace mode, to a 24- or 32-bit color raw image, + or the same color type as the PNG +*) encoding of PNGs, from any raw image to 24- or 32-bit color, or the same color type as the raw image +*) Adam7 interlace and deinterlace for any color type +*) loading the image from harddisk or decoding it from a buffer from other sources than harddisk +*) support for alpha channels, including RGBA color model, translucent palettes and color keying +*) zlib decompression (inflate) +*) zlib compression (deflate) +*) CRC32 and ADLER32 checksums +*) colorimetric color profile conversions: currently experimentally available in lodepng_util.cpp only, + plus alternatively ability to pass on chroma/gamma/ICC profile information to other color management system. +*) handling of unknown chunks, allowing making a PNG editor that stores custom and unknown chunks. +*) the following chunks are supported by both encoder and decoder: + IHDR: header information + PLTE: color palette + IDAT: pixel data + IEND: the final chunk + tRNS: transparency for palettized images + tEXt: textual information + zTXt: compressed textual information + iTXt: international textual information + bKGD: suggested background color + pHYs: physical dimensions + tIME: modification time + cHRM: RGB chromaticities + gAMA: RGB gamma correction + iCCP: ICC color profile + sRGB: rendering intent + +1.2. features not supported +--------------------------- + +The following features are _not_ supported: + +*) some features needed to make a conformant PNG-Editor might be still missing. +*) partial loading/stream processing. All data must be available and is processed in one call. +*) The following public chunks are not (yet) supported but treated as unknown chunks by LodePNG: + sBIT + hIST + sPLT + + +2. C and C++ version +-------------------- + +The C version uses buffers allocated with alloc that you need to free() +yourself. You need to use init and cleanup functions for each struct whenever +using a struct from the C version to avoid exploits and memory leaks. + +The C++ version has extra functions with std::vectors in the interface and the +lodepng::State class which is a LodePNGState with constructor and destructor. + +These files work without modification for both C and C++ compilers because all +the additional C++ code is in "#ifdef __cplusplus" blocks that make C-compilers +ignore it, and the C code is made to compile both with strict ISO C90 and C++. + +To use the C++ version, you need to rename the source file to lodepng.cpp +(instead of lodepng.c), and compile it with a C++ compiler. + +To use the C version, you need to rename the source file to lodepng.c (instead +of lodepng.cpp), and compile it with a C compiler. + + +3. Security +----------- + +Even if carefully designed, it's always possible that LodePNG contains possible +exploits. If you discover one, please let me know, and it will be fixed. + +When using LodePNG, care has to be taken with the C version of LodePNG, as well +as the C-style structs when working with C++. The following conventions are used +for all C-style structs: + +-if a struct has a corresponding init function, always call the init function when making a new one +-if a struct has a corresponding cleanup function, call it before the struct disappears to avoid memory leaks +-if a struct has a corresponding copy function, use the copy function instead of "=". + The destination must also be inited already. + + +4. Decoding +----------- + +Decoding converts a PNG compressed image to a raw pixel buffer. + +Most documentation on using the decoder is at its declarations in the header +above. For C, simple decoding can be done with functions such as +lodepng_decode32, and more advanced decoding can be done with the struct +LodePNGState and lodepng_decode. For C++, all decoding can be done with the +various lodepng::decode functions, and lodepng::State can be used for advanced +features. + +When using the LodePNGState, it uses the following fields for decoding: +*) LodePNGInfo info_png: it stores extra information about the PNG (the input) in here +*) LodePNGColorMode info_raw: here you can say what color mode of the raw image (the output) you want to get +*) LodePNGDecoderSettings decoder: you can specify a few extra settings for the decoder to use + +LodePNGInfo info_png +-------------------- + +After decoding, this contains extra information of the PNG image, except the actual +pixels, width and height because these are already gotten directly from the decoder +functions. + +It contains for example the original color type of the PNG image, text comments, +suggested background color, etc... More details about the LodePNGInfo struct are +at its declaration documentation. + +LodePNGColorMode info_raw +------------------------- + +When decoding, here you can specify which color type you want +the resulting raw image to be. If this is different from the colortype of the +PNG, then the decoder will automatically convert the result. This conversion +always works, except if you want it to convert a color PNG to grayscale or to +a palette with missing colors. + +By default, 32-bit color is used for the result. + +LodePNGDecoderSettings decoder +------------------------------ + +The settings can be used to ignore the errors created by invalid CRC and Adler32 +chunks, and to disable the decoding of tEXt chunks. + +There's also a setting color_convert, true by default. If false, no conversion +is done, the resulting data will be as it was in the PNG (after decompression) +and you'll have to puzzle the colors of the pixels together yourself using the +color type information in the LodePNGInfo. + + +5. Encoding +----------- + +Encoding converts a raw pixel buffer to a PNG compressed image. + +Most documentation on using the encoder is at its declarations in the header +above. For C, simple encoding can be done with functions such as +lodepng_encode32, and more advanced decoding can be done with the struct +LodePNGState and lodepng_encode. For C++, all encoding can be done with the +various lodepng::encode functions, and lodepng::State can be used for advanced +features. + +Like the decoder, the encoder can also give errors. However it gives less errors +since the encoder input is trusted, the decoder input (a PNG image that could +be forged by anyone) is not trusted. + +When using the LodePNGState, it uses the following fields for encoding: +*) LodePNGInfo info_png: here you specify how you want the PNG (the output) to be. +*) LodePNGColorMode info_raw: here you say what color type of the raw image (the input) has +*) LodePNGEncoderSettings encoder: you can specify a few settings for the encoder to use + +LodePNGInfo info_png +-------------------- + +When encoding, you use this the opposite way as when decoding: for encoding, +you fill in the values you want the PNG to have before encoding. By default it's +not needed to specify a color type for the PNG since it's automatically chosen, +but it's possible to choose it yourself given the right settings. + +The encoder will not always exactly match the LodePNGInfo struct you give, +it tries as close as possible. Some things are ignored by the encoder. The +encoder uses, for example, the following settings from it when applicable: +colortype and bitdepth, text chunks, time chunk, the color key, the palette, the +background color, the interlace method, unknown chunks, ... + +When encoding to a PNG with colortype 3, the encoder will generate a PLTE chunk. +If the palette contains any colors for which the alpha channel is not 255 (so +there are translucent colors in the palette), it'll add a tRNS chunk. + +LodePNGColorMode info_raw +------------------------- + +You specify the color type of the raw image that you give to the input here, +including a possible transparent color key and palette you happen to be using in +your raw image data. + +By default, 32-bit color is assumed, meaning your input has to be in RGBA +format with 4 bytes (unsigned chars) per pixel. + +LodePNGEncoderSettings encoder +------------------------------ + +The following settings are supported (some are in sub-structs): +*) auto_convert: when this option is enabled, the encoder will +automatically choose the smallest possible color mode (including color key) that +can encode the colors of all pixels without information loss. +*) btype: the block type for LZ77. 0 = uncompressed, 1 = fixed huffman tree, + 2 = dynamic huffman tree (best compression). Should be 2 for proper + compression. +*) use_lz77: whether or not to use LZ77 for compressed block types. Should be + true for proper compression. +*) windowsize: the window size used by the LZ77 encoder (1 - 32768). Has value + 2048 by default, but can be set to 32768 for better, but slow, compression. +*) force_palette: if colortype is 2 or 6, you can make the encoder write a PLTE + chunk if force_palette is true. This can used as suggested palette to convert + to by viewers that don't support more than 256 colors (if those still exist) +*) add_id: add text chunk "Encoder: LodePNG " to the image. +*) text_compression: default 1. If 1, it'll store texts as zTXt instead of tEXt chunks. + zTXt chunks use zlib compression on the text. This gives a smaller result on + large texts but a larger result on small texts (such as a single program name). + It's all tEXt or all zTXt though, there's no separate setting per text yet. + + +6. color conversions +-------------------- + +An important thing to note about LodePNG, is that the color type of the PNG, and +the color type of the raw image, are completely independent. By default, when +you decode a PNG, you get the result as a raw image in the color type you want, +no matter whether the PNG was encoded with a palette, grayscale or RGBA color. +And if you encode an image, by default LodePNG will automatically choose the PNG +color type that gives good compression based on the values of colors and amount +of colors in the image. It can be configured to let you control it instead as +well, though. + +To be able to do this, LodePNG does conversions from one color mode to another. +It can convert from almost any color type to any other color type, except the +following conversions: RGB to grayscale is not supported, and converting to a +palette when the palette doesn't have a required color is not supported. This is +not supported on purpose: this is information loss which requires a color +reduction algorithm that is beyong the scope of a PNG encoder (yes, RGB to gray +is easy, but there are multiple ways if you want to give some channels more +weight). + +By default, when decoding, you get the raw image in 32-bit RGBA or 24-bit RGB +color, no matter what color type the PNG has. And by default when encoding, +LodePNG automatically picks the best color model for the output PNG, and expects +the input image to be 32-bit RGBA or 24-bit RGB. So, unless you want to control +the color format of the images yourself, you can skip this chapter. + +6.1. PNG color types +-------------------- + +A PNG image can have many color types, ranging from 1-bit color to 64-bit color, +as well as palettized color modes. After the zlib decompression and unfiltering +in the PNG image is done, the raw pixel data will have that color type and thus +a certain amount of bits per pixel. If you want the output raw image after +decoding to have another color type, a conversion is done by LodePNG. + +The PNG specification gives the following color types: + +0: grayscale, bit depths 1, 2, 4, 8, 16 +2: RGB, bit depths 8 and 16 +3: palette, bit depths 1, 2, 4 and 8 +4: grayscale with alpha, bit depths 8 and 16 +6: RGBA, bit depths 8 and 16 + +Bit depth is the amount of bits per pixel per color channel. So the total amount +of bits per pixel is: amount of channels * bitdepth. + +6.2. color conversions +---------------------- + +As explained in the sections about the encoder and decoder, you can specify +color types and bit depths in info_png and info_raw to change the default +behaviour. + +If, when decoding, you want the raw image to be something else than the default, +you need to set the color type and bit depth you want in the LodePNGColorMode, +or the parameters colortype and bitdepth of the simple decoding function. + +If, when encoding, you use another color type than the default in the raw input +image, you need to specify its color type and bit depth in the LodePNGColorMode +of the raw image, or use the parameters colortype and bitdepth of the simple +encoding function. + +If, when encoding, you don't want LodePNG to choose the output PNG color type +but control it yourself, you need to set auto_convert in the encoder settings +to false, and specify the color type you want in the LodePNGInfo of the +encoder (including palette: it can generate a palette if auto_convert is true, +otherwise not). + +If the input and output color type differ (whether user chosen or auto chosen), +LodePNG will do a color conversion, which follows the rules below, and may +sometimes result in an error. + +To avoid some confusion: +-the decoder converts from PNG to raw image +-the encoder converts from raw image to PNG +-the colortype and bitdepth in LodePNGColorMode info_raw, are those of the raw image +-the colortype and bitdepth in the color field of LodePNGInfo info_png, are those of the PNG +-when encoding, the color type in LodePNGInfo is ignored if auto_convert + is enabled, it is automatically generated instead +-when decoding, the color type in LodePNGInfo is set by the decoder to that of the original + PNG image, but it can be ignored since the raw image has the color type you requested instead +-if the color type of the LodePNGColorMode and PNG image aren't the same, a conversion + between the color types is done if the color types are supported. If it is not + supported, an error is returned. If the types are the same, no conversion is done. +-even though some conversions aren't supported, LodePNG supports loading PNGs from any + colortype and saving PNGs to any colortype, sometimes it just requires preparing + the raw image correctly before encoding. +-both encoder and decoder use the same color converter. + +The function lodepng_convert does the color conversion. It is available in the +interface but normally isn't needed since the encoder and decoder already call +it. + +Non supported color conversions: +-color to grayscale when non-gray pixels are present: no error is thrown, but +the result will look ugly because only the red channel is taken (it assumes all +three channels are the same in this case so ignores green and blue). The reason +no error is given is to allow converting from three-channel grayscale images to +one-channel even if there are numerical imprecisions. +-anything to palette when the palette does not have an exact match for a from-color +in it: in this case an error is thrown + +Supported color conversions: +-anything to 8-bit RGB, 8-bit RGBA, 16-bit RGB, 16-bit RGBA +-any gray or gray+alpha, to gray or gray+alpha +-anything to a palette, as long as the palette has the requested colors in it +-removing alpha channel +-higher to smaller bitdepth, and vice versa + +If you want no color conversion to be done (e.g. for speed or control): +-In the encoder, you can make it save a PNG with any color type by giving the +raw color mode and LodePNGInfo the same color mode, and setting auto_convert to +false. +-In the decoder, you can make it store the pixel data in the same color type +as the PNG has, by setting the color_convert setting to false. Settings in +info_raw are then ignored. + +6.3. padding bits +----------------- + +In the PNG file format, if a less than 8-bit per pixel color type is used and the scanlines +have a bit amount that isn't a multiple of 8, then padding bits are used so that each +scanline starts at a fresh byte. But that is NOT true for the LodePNG raw input and output. +The raw input image you give to the encoder, and the raw output image you get from the decoder +will NOT have these padding bits, e.g. in the case of a 1-bit image with a width +of 7 pixels, the first pixel of the second scanline will the the 8th bit of the first byte, +not the first bit of a new byte. + +6.4. A note about 16-bits per channel and endianness +---------------------------------------------------- + +LodePNG uses unsigned char arrays for 16-bit per channel colors too, just like +for any other color format. The 16-bit values are stored in big endian (most +significant byte first) in these arrays. This is the opposite order of the +little endian used by x86 CPU's. + +LodePNG always uses big endian because the PNG file format does so internally. +Conversions to other formats than PNG uses internally are not supported by +LodePNG on purpose, there are myriads of formats, including endianness of 16-bit +colors, the order in which you store R, G, B and A, and so on. Supporting and +converting to/from all that is outside the scope of LodePNG. + +This may mean that, depending on your use case, you may want to convert the big +endian output of LodePNG to little endian with a for loop. This is certainly not +always needed, many applications and libraries support big endian 16-bit colors +anyway, but it means you cannot simply cast the unsigned char* buffer to an +unsigned short* buffer on x86 CPUs. + + +7. error values +--------------- + +All functions in LodePNG that return an error code, return 0 if everything went +OK, or a non-zero code if there was an error. + +The meaning of the LodePNG error values can be retrieved with the function +lodepng_error_text: given the numerical error code, it returns a description +of the error in English as a string. + +Check the implementation of lodepng_error_text to see the meaning of each code. + + +8. chunks and PNG editing +------------------------- + +If you want to add extra chunks to a PNG you encode, or use LodePNG for a PNG +editor that should follow the rules about handling of unknown chunks, or if your +program is able to read other types of chunks than the ones handled by LodePNG, +then that's possible with the chunk functions of LodePNG. + +A PNG chunk has the following layout: + +4 bytes length +4 bytes type name +length bytes data +4 bytes CRC + +8.1. iterating through chunks +----------------------------- + +If you have a buffer containing the PNG image data, then the first chunk (the +IHDR chunk) starts at byte number 8 of that buffer. The first 8 bytes are the +signature of the PNG and are not part of a chunk. But if you start at byte 8 +then you have a chunk, and can check the following things of it. + +NOTE: none of these functions check for memory buffer boundaries. To avoid +exploits, always make sure the buffer contains all the data of the chunks. +When using lodepng_chunk_next, make sure the returned value is within the +allocated memory. + +unsigned lodepng_chunk_length(const unsigned char* chunk): + +Get the length of the chunk's data. The total chunk length is this length + 12. + +void lodepng_chunk_type(char type[5], const unsigned char* chunk): +unsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type): + +Get the type of the chunk or compare if it's a certain type + +unsigned char lodepng_chunk_critical(const unsigned char* chunk): +unsigned char lodepng_chunk_private(const unsigned char* chunk): +unsigned char lodepng_chunk_safetocopy(const unsigned char* chunk): + +Check if the chunk is critical in the PNG standard (only IHDR, PLTE, IDAT and IEND are). +Check if the chunk is private (public chunks are part of the standard, private ones not). +Check if the chunk is safe to copy. If it's not, then, when modifying data in a critical +chunk, unsafe to copy chunks of the old image may NOT be saved in the new one if your +program doesn't handle that type of unknown chunk. + +unsigned char* lodepng_chunk_data(unsigned char* chunk): +const unsigned char* lodepng_chunk_data_const(const unsigned char* chunk): + +Get a pointer to the start of the data of the chunk. + +unsigned lodepng_chunk_check_crc(const unsigned char* chunk): +void lodepng_chunk_generate_crc(unsigned char* chunk): + +Check if the crc is correct or generate a correct one. + +unsigned char* lodepng_chunk_next(unsigned char* chunk): +const unsigned char* lodepng_chunk_next_const(const unsigned char* chunk): + +Iterate to the next chunk. This works if you have a buffer with consecutive chunks. Note that these +functions do no boundary checking of the allocated data whatsoever, so make sure there is enough +data available in the buffer to be able to go to the next chunk. + +unsigned lodepng_chunk_append(unsigned char** out, size_t* outlength, const unsigned char* chunk): +unsigned lodepng_chunk_create(unsigned char** out, size_t* outlength, unsigned length, + const char* type, const unsigned char* data): + +These functions are used to create new chunks that are appended to the data in *out that has +length *outlength. The append function appends an existing chunk to the new data. The create +function creates a new chunk with the given parameters and appends it. Type is the 4-letter +name of the chunk. + +8.2. chunks in info_png +----------------------- + +The LodePNGInfo struct contains fields with the unknown chunk in it. It has 3 +buffers (each with size) to contain 3 types of unknown chunks: +the ones that come before the PLTE chunk, the ones that come between the PLTE +and the IDAT chunks, and the ones that come after the IDAT chunks. +It's necessary to make the distionction between these 3 cases because the PNG +standard forces to keep the ordering of unknown chunks compared to the critical +chunks, but does not force any other ordering rules. + +info_png.unknown_chunks_data[0] is the chunks before PLTE +info_png.unknown_chunks_data[1] is the chunks after PLTE, before IDAT +info_png.unknown_chunks_data[2] is the chunks after IDAT + +The chunks in these 3 buffers can be iterated through and read by using the same +way described in the previous subchapter. + +When using the decoder to decode a PNG, you can make it store all unknown chunks +if you set the option settings.remember_unknown_chunks to 1. By default, this +option is off (0). + +The encoder will always encode unknown chunks that are stored in the info_png. +If you need it to add a particular chunk that isn't known by LodePNG, you can +use lodepng_chunk_append or lodepng_chunk_create to the chunk data in +info_png.unknown_chunks_data[x]. + +Chunks that are known by LodePNG should not be added in that way. E.g. to make +LodePNG add a bKGD chunk, set background_defined to true and add the correct +parameters there instead. + + +9. compiler support +------------------- + +No libraries other than the current standard C library are needed to compile +LodePNG. For the C++ version, only the standard C++ library is needed on top. +Add the files lodepng.c(pp) and lodepng.h to your project, include +lodepng.h where needed, and your program can read/write PNG files. + +It is compatible with C90 and up, and C++03 and up. + +If performance is important, use optimization when compiling! For both the +encoder and decoder, this makes a large difference. + +Make sure that LodePNG is compiled with the same compiler of the same version +and with the same settings as the rest of the program, or the interfaces with +std::vectors and std::strings in C++ can be incompatible. + +CHAR_BITS must be 8 or higher, because LodePNG uses unsigned chars for octets. + +*) gcc and g++ + +LodePNG is developed in gcc so this compiler is natively supported. It gives no +warnings with compiler options "-Wall -Wextra -pedantic -ansi", with gcc and g++ +version 4.7.1 on Linux, 32-bit and 64-bit. + +*) Clang + +Fully supported and warning-free. + +*) Mingw + +The Mingw compiler (a port of gcc for Windows) should be fully supported by +LodePNG. + +*) Visual Studio and Visual C++ Express Edition + +LodePNG should be warning-free with warning level W4. Two warnings were disabled +with pragmas though: warning 4244 about implicit conversions, and warning 4996 +where it wants to use a non-standard function fopen_s instead of the standard C +fopen. + +Visual Studio may want "stdafx.h" files to be included in each source file and +give an error "unexpected end of file while looking for precompiled header". +This is not standard C++ and will not be added to the stock LodePNG. You can +disable it for lodepng.cpp only by right clicking it, Properties, C/C++, +Precompiled Headers, and set it to Not Using Precompiled Headers there. + +NOTE: Modern versions of VS should be fully supported, but old versions, e.g. +VS6, are not guaranteed to work. + +*) Compilers on Macintosh + +LodePNG has been reported to work both with gcc and LLVM for Macintosh, both for +C and C++. + +*) Other Compilers + +If you encounter problems on any compilers, feel free to let me know and I may +try to fix it if the compiler is modern and standards complient. + + +10. examples +------------ + +This decoder example shows the most basic usage of LodePNG. More complex +examples can be found on the LodePNG website. + +10.1. decoder C++ example +------------------------- + +#include "lodepng.h" +#include + +int main(int argc, char *argv[]) { + const char* filename = argc > 1 ? argv[1] : "test.png"; + + //load and decode + std::vector image; + unsigned width, height; + unsigned error = lodepng::decode(image, width, height, filename); + + //if there's an error, display it + if(error) std::cout << "decoder error " << error << ": " << lodepng_error_text(error) << std::endl; + + //the pixels are now in the vector "image", 4 bytes per pixel, ordered RGBARGBA..., use it as texture, draw it, ... +} + +10.2. decoder C example +----------------------- + +#include "lodepng.h" + +int main(int argc, char *argv[]) { + unsigned error; + unsigned char* image; + size_t width, height; + const char* filename = argc > 1 ? argv[1] : "test.png"; + + error = lodepng_decode32_file(&image, &width, &height, filename); + + if(error) printf("decoder error %u: %s\n", error, lodepng_error_text(error)); + + / * use image here * / + + free(image); + return 0; +} + +11. state settings reference +---------------------------- + +A quick reference of some settings to set on the LodePNGState + +For decoding: + +state.decoder.zlibsettings.ignore_adler32: ignore ADLER32 checksums +state.decoder.zlibsettings.custom_...: use custom inflate function +state.decoder.ignore_crc: ignore CRC checksums +state.decoder.ignore_critical: ignore unknown critical chunks +state.decoder.ignore_end: ignore missing IEND chunk. May fail if this corruption causes other errors +state.decoder.color_convert: convert internal PNG color to chosen one +state.decoder.read_text_chunks: whether to read in text metadata chunks +state.decoder.remember_unknown_chunks: whether to read in unknown chunks +state.info_raw.colortype: desired color type for decoded image +state.info_raw.bitdepth: desired bit depth for decoded image +state.info_raw....: more color settings, see struct LodePNGColorMode +state.info_png....: no settings for decoder but ouput, see struct LodePNGInfo + +For encoding: + +state.encoder.zlibsettings.btype: disable compression by setting it to 0 +state.encoder.zlibsettings.use_lz77: use LZ77 in compression +state.encoder.zlibsettings.windowsize: tweak LZ77 windowsize +state.encoder.zlibsettings.minmatch: tweak min LZ77 length to match +state.encoder.zlibsettings.nicematch: tweak LZ77 match where to stop searching +state.encoder.zlibsettings.lazymatching: try one more LZ77 matching +state.encoder.zlibsettings.custom_...: use custom deflate function +state.encoder.auto_convert: choose optimal PNG color type, if 0 uses info_png +state.encoder.filter_palette_zero: PNG filter strategy for palette +state.encoder.filter_strategy: PNG filter strategy to encode with +state.encoder.force_palette: add palette even if not encoding to one +state.encoder.add_id: add LodePNG identifier and version as a text chunk +state.encoder.text_compression: use compressed text chunks for metadata +state.info_raw.colortype: color type of raw input image you provide +state.info_raw.bitdepth: bit depth of raw input image you provide +state.info_raw: more color settings, see struct LodePNGColorMode +state.info_png.color.colortype: desired color type if auto_convert is false +state.info_png.color.bitdepth: desired bit depth if auto_convert is false +state.info_png.color....: more color settings, see struct LodePNGColorMode +state.info_png....: more PNG related settings, see struct LodePNGInfo + + +12. changes +----------- + +The version number of LodePNG is the date of the change given in the format +yyyymmdd. + +Some changes aren't backwards compatible. Those are indicated with a (!) +symbol. + +*) 30 dec 2018: code style changes only: removed newlines before opening braces. +*) 10 sep 2018: added way to inspect metadata chunks without full decoding. +*) 19 aug 2018 (!): fixed color mode bKGD is encoded with and made it use + palette index in case of palette. +*) 10 aug 2018 (!): added support for gAMA, cHRM, sRGB and iCCP chunks. This + change is backwards compatible unless you relied on unknown_chunks for those. +*) 11 jun 2018: less restrictive check for pixel size integer overflow +*) 14 jan 2018: allow optionally ignoring a few more recoverable errors +*) 17 sep 2017: fix memory leak for some encoder input error cases +*) 27 nov 2016: grey+alpha auto color model detection bugfix +*) 18 apr 2016: Changed qsort to custom stable sort (for platforms w/o qsort). +*) 09 apr 2016: Fixed colorkey usage detection, and better file loading (within + the limits of pure C90). +*) 08 dec 2015: Made load_file function return error if file can't be opened. +*) 24 okt 2015: Bugfix with decoding to palette output. +*) 18 apr 2015: Boundary PM instead of just package-merge for faster encoding. +*) 23 aug 2014: Reduced needless memory usage of decoder. +*) 28 jun 2014: Removed fix_png setting, always support palette OOB for + simplicity. Made ColorProfile public. +*) 09 jun 2014: Faster encoder by fixing hash bug and more zeros optimization. +*) 22 dec 2013: Power of two windowsize required for optimization. +*) 15 apr 2013: Fixed bug with LAC_ALPHA and color key. +*) 25 mar 2013: Added an optional feature to ignore some PNG errors (fix_png). +*) 11 mar 2013 (!): Bugfix with custom free. Changed from "my" to "lodepng_" + prefix for the custom allocators and made it possible with a new #define to + use custom ones in your project without needing to change lodepng's code. +*) 28 jan 2013: Bugfix with color key. +*) 27 okt 2012: Tweaks in text chunk keyword length error handling. +*) 8 okt 2012 (!): Added new filter strategy (entropy) and new auto color mode. + (no palette). Better deflate tree encoding. New compression tweak settings. + Faster color conversions while decoding. Some internal cleanups. +*) 23 sep 2012: Reduced warnings in Visual Studio a little bit. +*) 1 sep 2012 (!): Removed #define's for giving custom (de)compression functions + and made it work with function pointers instead. +*) 23 jun 2012: Added more filter strategies. Made it easier to use custom alloc + and free functions and toggle #defines from compiler flags. Small fixes. +*) 6 may 2012 (!): Made plugging in custom zlib/deflate functions more flexible. +*) 22 apr 2012 (!): Made interface more consistent, renaming a lot. Removed + redundant C++ codec classes. Reduced amount of structs. Everything changed, + but it is cleaner now imho and functionality remains the same. Also fixed + several bugs and shrunk the implementation code. Made new samples. +*) 6 nov 2011 (!): By default, the encoder now automatically chooses the best + PNG color model and bit depth, based on the amount and type of colors of the + raw image. For this, autoLeaveOutAlphaChannel replaced by auto_choose_color. +*) 9 okt 2011: simpler hash chain implementation for the encoder. +*) 8 sep 2011: lz77 encoder lazy matching instead of greedy matching. +*) 23 aug 2011: tweaked the zlib compression parameters after benchmarking. + A bug with the PNG filtertype heuristic was fixed, so that it chooses much + better ones (it's quite significant). A setting to do an experimental, slow, + brute force search for PNG filter types is added. +*) 17 aug 2011 (!): changed some C zlib related function names. +*) 16 aug 2011: made the code less wide (max 120 characters per line). +*) 17 apr 2011: code cleanup. Bugfixes. Convert low to 16-bit per sample colors. +*) 21 feb 2011: fixed compiling for C90. Fixed compiling with sections disabled. +*) 11 dec 2010: encoding is made faster, based on suggestion by Peter Eastman + to optimize long sequences of zeros. +*) 13 nov 2010: added LodePNG_InfoColor_hasPaletteAlpha and + LodePNG_InfoColor_canHaveAlpha functions for convenience. +*) 7 nov 2010: added LodePNG_error_text function to get error code description. +*) 30 okt 2010: made decoding slightly faster +*) 26 okt 2010: (!) changed some C function and struct names (more consistent). + Reorganized the documentation and the declaration order in the header. +*) 08 aug 2010: only changed some comments and external samples. +*) 05 jul 2010: fixed bug thanks to warnings in the new gcc version. +*) 14 mar 2010: fixed bug where too much memory was allocated for char buffers. +*) 02 sep 2008: fixed bug where it could create empty tree that linux apps could + read by ignoring the problem but windows apps couldn't. +*) 06 jun 2008: added more error checks for out of memory cases. +*) 26 apr 2008: added a few more checks here and there to ensure more safety. +*) 06 mar 2008: crash with encoding of strings fixed +*) 02 feb 2008: support for international text chunks added (iTXt) +*) 23 jan 2008: small cleanups, and #defines to divide code in sections +*) 20 jan 2008: support for unknown chunks allowing using LodePNG for an editor. +*) 18 jan 2008: support for tIME and pHYs chunks added to encoder and decoder. +*) 17 jan 2008: ability to encode and decode compressed zTXt chunks added + Also various fixes, such as in the deflate and the padding bits code. +*) 13 jan 2008: Added ability to encode Adam7-interlaced images. Improved + filtering code of encoder. +*) 07 jan 2008: (!) changed LodePNG to use ISO C90 instead of C++. A + C++ wrapper around this provides an interface almost identical to before. + Having LodePNG be pure ISO C90 makes it more portable. The C and C++ code + are together in these files but it works both for C and C++ compilers. +*) 29 dec 2007: (!) changed most integer types to unsigned int + other tweaks +*) 30 aug 2007: bug fixed which makes this Borland C++ compatible +*) 09 aug 2007: some VS2005 warnings removed again +*) 21 jul 2007: deflate code placed in new namespace separate from zlib code +*) 08 jun 2007: fixed bug with 2- and 4-bit color, and small interlaced images +*) 04 jun 2007: improved support for Visual Studio 2005: crash with accessing + invalid std::vector element [0] fixed, and level 3 and 4 warnings removed +*) 02 jun 2007: made the encoder add a tag with version by default +*) 27 may 2007: zlib and png code separated (but still in the same file), + simple encoder/decoder functions added for more simple usage cases +*) 19 may 2007: minor fixes, some code cleaning, new error added (error 69), + moved some examples from here to lodepng_examples.cpp +*) 12 may 2007: palette decoding bug fixed +*) 24 apr 2007: changed the license from BSD to the zlib license +*) 11 mar 2007: very simple addition: ability to encode bKGD chunks. +*) 04 mar 2007: (!) tEXt chunk related fixes, and support for encoding + palettized PNG images. Plus little interface change with palette and texts. +*) 03 mar 2007: Made it encode dynamic Huffman shorter with repeat codes. + Fixed a bug where the end code of a block had length 0 in the Huffman tree. +*) 26 feb 2007: Huffman compression with dynamic trees (BTYPE 2) now implemented + and supported by the encoder, resulting in smaller PNGs at the output. +*) 27 jan 2007: Made the Adler-32 test faster so that a timewaste is gone. +*) 24 jan 2007: gave encoder an error interface. Added color conversion from any + greyscale type to 8-bit greyscale with or without alpha. +*) 21 jan 2007: (!) Totally changed the interface. It allows more color types + to convert to and is more uniform. See the manual for how it works now. +*) 07 jan 2007: Some cleanup & fixes, and a few changes over the last days: + encode/decode custom tEXt chunks, separate classes for zlib & deflate, and + at last made the decoder give errors for incorrect Adler32 or Crc. +*) 01 jan 2007: Fixed bug with encoding PNGs with less than 8 bits per channel. +*) 29 dec 2006: Added support for encoding images without alpha channel, and + cleaned out code as well as making certain parts faster. +*) 28 dec 2006: Added "Settings" to the encoder. +*) 26 dec 2006: The encoder now does LZ77 encoding and produces much smaller files now. + Removed some code duplication in the decoder. Fixed little bug in an example. +*) 09 dec 2006: (!) Placed output parameters of public functions as first parameter. + Fixed a bug of the decoder with 16-bit per color. +*) 15 okt 2006: Changed documentation structure +*) 09 okt 2006: Encoder class added. It encodes a valid PNG image from the + given image buffer, however for now it's not compressed. +*) 08 sep 2006: (!) Changed to interface with a Decoder class +*) 30 jul 2006: (!) LodePNG_InfoPng , width and height are now retrieved in different + way. Renamed decodePNG to decodePNGGeneric. +*) 29 jul 2006: (!) Changed the interface: image info is now returned as a + struct of type LodePNG::LodePNG_Info, instead of a vector, which was a bit clumsy. +*) 28 jul 2006: Cleaned the code and added new error checks. + Corrected terminology "deflate" into "inflate". +*) 23 jun 2006: Added SDL example in the documentation in the header, this + example allows easy debugging by displaying the PNG and its transparency. +*) 22 jun 2006: (!) Changed way to obtain error value. Added + loadFile function for convenience. Made decodePNG32 faster. +*) 21 jun 2006: (!) Changed type of info vector to unsigned. + Changed position of palette in info vector. Fixed an important bug that + happened on PNGs with an uncompressed block. +*) 16 jun 2006: Internally changed unsigned into unsigned where + needed, and performed some optimizations. +*) 07 jun 2006: (!) Renamed functions to decodePNG and placed them + in LodePNG namespace. Changed the order of the parameters. Rewrote the + documentation in the header. Renamed files to lodepng.cpp and lodepng.h +*) 22 apr 2006: Optimized and improved some code +*) 07 sep 2005: (!) Changed to std::vector interface +*) 12 aug 2005: Initial release (C++, decoder only) + + +13. contact information +----------------------- + +Feel free to contact me with suggestions, problems, comments, ... concerning +LodePNG. If you encounter a PNG image that doesn't work properly with this +decoder, feel free to send it and I'll use it to find and fix the problem. + +My email address is (puzzle the account and domain together with an @ symbol): +Domain: gmail dot com. +Account: lode dot vandevenne. + + +Copyright (c) 2005-2019 Lode Vandevenne +*/ diff --git a/Lodepng-Source/makefile b/Lodepng-Source/makefile new file mode 100644 index 0000000..4df65da --- /dev/null +++ b/Lodepng-Source/makefile @@ -0,0 +1,27 @@ +TARGET = liblodepng.so +LIBS = +CC = gcc -shared -fPIC +CFLAGS = -D LODEPNG_NO_COMPILE_DECODER -D LODEPNG_NO_COMPILE_DISK -D LODEPNG_NO_COMPILE_ANCILLARY_CHUNKS -D LODEPNG_NO_COMPILE_ERROR_TEXT -D LODEPNG_NO_COMPILE_CPP + +.PHONY: clean all default + +default: $(TARGET) +all: default + +OBJECTS = $(patsubst %.c, %.o, $(wildcard *.c)) +HEADERS = $(wildcard *.h) + +%.o: %.c $(HEADERS) + $(CC) -c $(CFLAGS) $< -o $@ + +.PRECIOUS: $(TARGET) $(OBJECTS) + +$(TARGET): $(OBJECTS) + $(CC) $(OBJECTS) -Wall $(LIBS) -o $@ + sudo cp lodepng.h /usr/local/include + sudo cp $(TARGET) /usr/local/lib + sudo ldconfig + +clean: + -rm -f *.o + -rm -f $(TARGET) diff --git a/PHP-EXT-Source/config.m4 b/PHP-EXT-Source/config.m4 new file mode 100644 index 0000000..008787e --- /dev/null +++ b/PHP-EXT-Source/config.m4 @@ -0,0 +1,7 @@ +PHP_ARG_ENABLE(sspphp, + [Whether to enable the "sspphp" extension], + [-enable-sspphp Enable "sspphp" extension support]) +if test $PHP_SSPPHP != "no"; then + PHP_SUBST(SSPPHP_SHARED_LIBADD) + PHP_NEW_EXTENSION(sspphp, sspphp.c, $ext_shared) +fi \ No newline at end of file diff --git a/PHP-EXT-Source/sspphp.c b/PHP-EXT-Source/sspphp.c new file mode 100644 index 0000000..fcedc98 --- /dev/null +++ b/PHP-EXT-Source/sspphp.c @@ -0,0 +1,244 @@ +#include "sspphp.h" +#include "../SSP-API-Source/sspapi.h" + +#include + +static void *sspapi_handle; +static SQ_CHAR *(*phpPing)(); +static SQ_RCODE (*phpResetCounter)(); +static SQ_RCODE (*phpInitSqrlCfgData)(); +static SQ_RCODE (*phpInitSqrlSystem)(); +static SQ_RCODE (*phpShutDownSqrlSystem)(); +static void (*phpInitResponse)(SQRL_RESPONSE *pResponse); +static void (*phpSendRequest)(SQRL_CONTROL_BLOCK *pSCB); +static void (*phpFreeResponse)(SQRL_RESPONSE *pResponse); + +PHP_FUNCTION(sspapiOpenLibrary) { + php_printf("open_sspapi_library()
"); + + sspapi_handle=dlopen("libsspapi.so", RTLD_NOW | RTLD_GLOBAL | RTLD_NODELETE); + if(sspapi_handle==NULL) { + php_printf("dlerror (libsspapi): %s
", dlerror()); + RETURN_NULL(); + } + else { + php_printf("libsspapi.so opened successfully %p
", sspapi_handle); + } + + int n=0; + do { + char *error; + dlerror(); // clear any error + + n++; + *(void **) (&phpPing)=dlsym(sspapi_handle, "SSP_Ping"); + if((error=dlerror())!=NULL) break; + n++; + *(void **) (&phpResetCounter)=dlsym(sspapi_handle, "SSP_ResetCounter"); + if((error=dlerror())!=NULL) break; + n++; + + *(void **) (&phpInitSqrlCfgData)=dlsym(sspapi_handle, "SSP_InitSqrlCfgData"); + if((error=dlerror())!=NULL) break; + n++; + *(void **) (&phpInitSqrlSystem)=dlsym(sspapi_handle, "SSP_InitSqrlSystem"); + if((error=dlerror())!=NULL) break; + n++; + *(void **) (&phpShutDownSqrlSystem)=dlsym(sspapi_handle, "SSP_ShutDownSqrlSystem"); + if((error=dlerror())!=NULL) break; + n++; + *(void **) (&phpInitResponse)=dlsym(sspapi_handle, "SSP_InitResponse"); + if((error=dlerror())!=NULL) break; + n++; + *(void **) (&phpSendRequest)=dlsym(sspapi_handle, "SSP_SendRequest"); + if((error=dlerror())!=NULL) break; + n++; + *(void **) (&phpFreeResponse)=dlsym(sspapi_handle, "SSP_FreeResponse"); + if((error=dlerror())!=NULL) break; + + php_printf("dlsym(sspapi_handle): OK
"); + RETURN_TRUE; + } while (0); + php_printf("dlerror in dlsym(sspapi_handle): %d %s
", n, dlerror()); + RETURN_NULL(); +} + +PHP_FUNCTION(sspapiCloseLibrary) { + php_printf("close_sspapi_library()
"); + + int rc=dlclose(sspapi_handle); + if(rc!=0) { + php_printf("dlclose(%p): %d
", sspapi_handle, rc); + RETURN_NULL(); + } + else { + php_printf("libsspapi.so closed successfully
"); + } + RETURN_TRUE; +} + +PHP_FUNCTION(sspapiPing) { + php_printf("sspapiPing()
"); + php_printf("%s", phpPing()); + RETURN_TRUE; +} + +PHP_FUNCTION(sspapiResetCounter) { + php_printf("sspapiResetCounter()
"); + php_printf("rc: %d
", phpResetCounter()); + phpResetCounter(); + RETURN_TRUE; +} + +PHP_FUNCTION(sspapiInitSqrlCfgData) { + php_printf("sspapiInitSqrlCfgData()
"); + php_printf("rc: %d
", phpInitSqrlCfgData()); +phpInitSqrlCfgData(); + RETURN_TRUE; +} + +PHP_FUNCTION(sspapiInitSqrlSystem) { + php_printf("sspapiInitSqrlSystem()
"); + php_printf("rc: %d
", phpInitSqrlSystem()); +phpInitSqrlSystem(); + RETURN_TRUE; +} + +PHP_FUNCTION(sspapiShutDownSqrlSystem) { + php_printf("sspapiShutdownSqrlSystem()
"); + php_printf("rc: %d
", phpShutDownSqrlSystem()); +phpShutDownSqrlSystem(); + RETURN_TRUE; +} + +PHP_FUNCTION(sspapiSendRequest) { + php_printf("sspapiSendRequest()
"); + zval *arr, *data; + HashTable *arr_hash; + HashPosition pointer; + int array_count; + + enum{NUM_ELEMENTS=10}; + + if(zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &arr) == FAILURE) { + RETURN_NULL(); + } + arr_hash = Z_ARRVAL_P(arr); + array_count = zend_hash_num_elements(arr_hash); + + php_printf("The array passed contains %d elements
", array_count); + if(array_count!=NUM_ELEMENTS) { + php_printf("Error: The array must contain %d elements
", NUM_ELEMENTS); + RETURN_NULL(); + } + + SQRL_CONTROL_BLOCK scb; + + zend_hash_internal_pointer_reset_ex(arr_hash, &pointer); + for(int i=0; i"); + } + if(Z_TYPE_P(data) == IS_LONG){ + php_printf("%d: ", i); + php_printf("%ld", (long)Z_LVAL_P(data)); + php_printf("
"); + } + switch(i) { + case 0: scb.lpszMethod=Z_STRVAL_P(data); break; + case 1: scb.lpszPathInfo=Z_STRVAL_P(data); break; + case 2: scb.lpszQueryString=Z_STRVAL_P(data); break; + case 3: scb.DataLen=Z_LVAL_P(data); break; + case 4: scb.lpData=Z_STRVAL_P(data); break; + case 5: scb.lpszHttpHost=Z_STRVAL_P(data); break; + case 6: scb.lpszHttpReferrer=Z_STRVAL_P(data); break; + case 7: scb.lpszRemoteAddr=Z_STRVAL_P(data); break; + case 8: scb.lpszHttpOrigin=Z_STRVAL_P(data); break; + case 9: strcpy(scb.szServerPort, Z_STRVAL_P(data)) ; break; + } + zend_hash_move_forward_ex(arr_hash, &pointer); + } + + SQRL_RESPONSE rsp; + phpInitResponse(&rsp); + +php_printf("&rsp %p
", &rsp); +php_printf(" rsp.pszHeaders %p
", rsp.pszHeaders); +php_printf(" rsp.pData %p
", rsp.pData); +php_printf(" rsp.DataLen %d
", rsp.DataLen); + + scb.pResponse=&rsp; + + php_printf("*** %s
", scb.lpszMethod); + php_printf("*** %s
", scb.lpszPathInfo); + php_printf("*** %s
", scb.lpszQueryString); + php_printf("*** %d
", (int)scb.DataLen); + php_printf("*** %s
", scb.lpData); + php_printf("*** %s
", scb.lpszHttpHost); + php_printf("*** %s
", scb.lpszHttpReferrer); + php_printf("*** %s
", scb.lpszRemoteAddr); + php_printf("*** %s
", scb.lpszHttpOrigin); + php_printf("*** %s
", scb.szServerPort); + php_printf("*** %p
", scb.pResponse); + + phpSendRequest(&scb); + +php_printf("&rsp %p
", &rsp); +php_printf(" rsp.pszHeaders %p
", rsp.pszHeaders); +php_printf(" rsp.pData %p
", rsp.pData); +php_printf(" rsp.DataLen %d
", rsp.DataLen); + +for(int i=0; i"); + + array_init(return_value); + add_next_index_string(return_value, rsp.pszHeaders); + add_next_index_stringl(return_value, rsp.pData, rsp.DataLen); + add_next_index_long(return_value, rsp.DataLen); + + phpFreeResponse(&rsp); + + php_printf("&rsp %p
", &rsp); + php_printf(" rsp.pszHeaders %p
", rsp.pszHeaders); + php_printf(" rsp.pData %p
", rsp.pData); + php_printf(" rsp.DataLen %d
", rsp.DataLen); + + return; +} + +static zend_function_entry php_sspphp_functions[] = { + PHP_FE(sspapiOpenLibrary, NULL) + PHP_FE(sspapiCloseLibrary, NULL) + PHP_FE(sspapiPing, NULL) + PHP_FE(sspapiResetCounter, NULL) + PHP_FE(sspapiInitSqrlCfgData, NULL) + PHP_FE(sspapiInitSqrlSystem, NULL) + PHP_FE(sspapiShutDownSqrlSystem, NULL) + PHP_FE(sspapiSendRequest, NULL) + PHP_FE_END +}; +zend_module_entry sspphp_module_entry = { + #if ZEND_MODULE_API_NO >= 20010901 + STANDARD_MODULE_HEADER, // Roughly means if PHP Version > 4.2.0 + #endif + SSPPHP_EXTNAME, // Define PHP extension name + php_sspphp_functions, /* Functions */ + NULL, /* MINIT */ + NULL, /* MSHUTDOWN */ + NULL, /* RINIT */ + NULL, /* RSHUTDOWN */ + NULL, /* MINFO */ + #if ZEND_MODULE_API_NO >= 20010901 + SSPPHP_EXTVER, // Roughly means if PHP Version > 4.2.0 + #endif + STANDARD_MODULE_PROPERTIES +}; +#ifdef COMPILE_DL_SSPPHP + ZEND_GET_MODULE(sspphp) // Common for all PHP extensions which are build as shared modules +#endif + diff --git a/PHP-EXT-Source/sspphp.h b/PHP-EXT-Source/sspphp.h new file mode 100644 index 0000000..bb6be0b --- /dev/null +++ b/PHP-EXT-Source/sspphp.h @@ -0,0 +1,17 @@ +#ifndef SSPPHP_H +#define SSPPHP_H + +#define SSPPHP_EXTNAME "sspphp" +#define SSPPHP_EXTVER "1.0" + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include "php.h" + +extern zend_module_entry sspphp_module_entry; + +#define phpext_sspphp_ptr &sspphp_module_entry + +#endif diff --git a/SSP-API-Demo/.sspapi.cfg b/SSP-API-Demo/.sspapi.cfg new file mode 100644 index 0000000..de9a092 --- /dev/null +++ b/SSP-API-Demo/.sspapi.cfg @@ -0,0 +1,21 @@ +MonotonicCounter=0000000000000000 +HandlerName=OpenSSL +CertFilename=ssp.server.crt +KeyFilename=ssp.server.key +ListenIP= +ListenPort=8443 +PrivateAccessIP= +SystemKey= +DatabaseKey= +TransactionLogging=1 +PublicAuthDomain=https://web.server +WebServerAuthURL0=https://web.server/auth +WebServerAuthURL1= +WebServerAuthURL2= +WebServerAuthURL3= +WebServerAuthURL4= +WebServerAuthURL5= +WebServerAuthURL6= +WebServerAuthURL7= +WebServerAuthURL8= +WebServerAuthURL9= diff --git a/SSP-API-Demo/DebugFilter.txt b/SSP-API-Demo/DebugFilter.txt new file mode 100644 index 0000000..f9f27cd --- /dev/null +++ b/SSP-API-Demo/DebugFilter.txt @@ -0,0 +1,5 @@ +GlobalAlloc()GlobalFree() +InitializeCriticalSection() +EnterCriticalSection() +LeaveCriticalSection() +DeleteCriticalSection() diff --git a/SSP-API-Demo/auth.index.php b/SSP-API-Demo/auth.index.php new file mode 100644 index 0000000..ae945e2 --- /dev/null +++ b/SSP-API-Demo/auth.index.php @@ -0,0 +1,133 @@ + + + + SSP-API CPS Authentication + + + +"; + +echo "
QUERY_STRING: "; +echo isset($_SERVER['QUERY_STRING'])? $_SERVER['QUERY_STRING']: "(none)"; // Query String +echo "
CONTENT_LENGTH: "; +echo isset($_SERVER['CONTENT_LENGTH'])? intval($_SERVER['CONTENT_LENGTH']): 0; // Data Length +echo "
HTTP_HOST: "; +echo isset($_SERVER['HTTP_HOST'])? $_SERVER['HTTP_HOST']: "(none)"; // Http Host +echo "
HTTP_REFERER: "; +echo isset($_SERVER['HTTP_REFERER'])? $_SERVER['HTTP_REFERER']: "(none)"; // Http Referrer +echo "
REMOTE_ADDR: "; +echo isset($_SERVER['REMOTE_ADDR'])? $_SERVER['REMOTE_ADDR']: "(none)"; // Remote Address +echo "
HTTP_ORIGIN: "; +echo isset($_SERVER['HTTP_ORIGIN'])? $_SERVER['HTTP_ORIGIN']: "(none)"; // Http Origin + +echo "
"; +echo "
"; + +echo "_SERVER:
"; +$n=0; +while ($key = key($_SERVER)) { +$n++; + echo $n.' '.$key.':'.$_SERVER[$key]; + echo "
"; + next($_SERVER); +} + +echo "_GET:
"; +$n=0; +while ($key = key($_GET)) { +$n++; + echo $n.' '.$key.':'.$_GET[$key]; + echo "
"; + next($_GET); +} + +echo "_POST:
"; +$n=0; +while ($key = key($_POST)) { +$n++; + echo $n.' '.$key.':'.$_POST[$key]; + echo "
"; + next($_POST); +} + +echo "_REQUEST:
"; +$n=0; +while ($key = key($_REQUEST)) { +$n++; + echo $n.' '.$key.':'.$_REQUEST[$key]; + echo "
"; + next($_REQUEST); +} + + +// "streamContext" gets around the problem of self-signed certificates not being accepted +$streamContext = stream_context_create( +[ +'ssl' => [ + 'verify_peer' => false, + 'verify_peer_name' => false + ] +]); + +// web.server -> ssp.server +// ------------------------ + +$B64 = array("+", "/"); +$B64url = array("-", "/"); +$CRLF = array("\r\n"); +$BR = array("
"); + +echo "
/cps.sqrl"; +$cps_token=$_SERVER['QUERY_STRING']; +$cps_url='https://ssp.server:8443/cps.sqrl?'.$cps_token; +echo "
".$cps_url; +$cps_result=file_get_contents($cps_url, false, $streamContext); +echo "
cps_result:
"; +if($cps_result!==false) { echo $cps_result;} else {echo "(none)";} +$user="(none)"; +$stat="(none)"; +$name="(none)"; +$acct="(none)"; +parse_str($cps_result); +echo "
Parsed:"; +echo "
user=".$user; +echo "
stat=".$stat; +echo "
auth'&name'=".base64_decode(str_replace($B64url, $B64, $name)); +echo "
acct=".$acct; + +echo "
"; +echo "
/add.sqrl"; +$add_query='acct=TestAccount&user='.$user.'&stat='.$stat.'&name=user-name'; +$add_url='https://ssp.server:8443/add.sqrl?'.$add_query; +echo "
".$add_url; +$add_result=file_get_contents($add_url, false, $streamContext); +$add_result=str_replace($CRLF, $BR, $add_result); +echo "
add_result:
"; +if($add_result!==false) { + echo $add_result; + $add_result_explode =explode("
", $add_result); + echo "
Parsed:"; + $i=0; + while ($i[".$i."]"; + echo "
user=".$user; + echo "
acct=".$acct; + echo "
name=".$name; + echo "
stat=".$stat; + echo "
invt=".$invt; + $i++; + } +} else {echo "(none)";} + +?> + diff --git a/SSP-API-Demo/rf.sh b/SSP-API-Demo/rf.sh new file mode 100644 index 0000000..6e77d2d --- /dev/null +++ b/SSP-API-Demo/rf.sh @@ -0,0 +1,5 @@ +#!/bin/bash +sudo /opt/lampp/lampp stop +sudo /opt/lampp/lampp start +./sspfunc + diff --git a/SSP-API-Demo/rh.sh b/SSP-API-Demo/rh.sh new file mode 100644 index 0000000..97a46a1 --- /dev/null +++ b/SSP-API-Demo/rh.sh @@ -0,0 +1,5 @@ +#!/bin/bash +sudo /opt/lampp/lampp stop +sudo /opt/lampp/lampp start +./ssphttp + diff --git a/SSP-API-Demo/rx.sh b/SSP-API-Demo/rx.sh new file mode 100644 index 0000000..67fea3f --- /dev/null +++ b/SSP-API-Demo/rx.sh @@ -0,0 +1,5 @@ +#!/bin/bash +sudo /opt/lampp/lampp stop +sudo /opt/lampp/lampp start + + diff --git a/SSP-API-Demo/sqrl.index.php b/SSP-API-Demo/sqrl.index.php new file mode 100644 index 0000000..c973966 --- /dev/null +++ b/SSP-API-Demo/sqrl.index.php @@ -0,0 +1,151 @@ + + + + + GRC SQRL Service Provider API for Linux Test/Demo + + + + + +
+
+
+ http:// probe image +
+ +
+ + +
+
+ Or Scan the QR Code +
+ +
+
+ QR Code +
+ +
+ +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + diff --git a/SSP-API-Demo/ssp.server.crt b/SSP-API-Demo/ssp.server.crt new file mode 100644 index 0000000..77b81f5 --- /dev/null +++ b/SSP-API-Demo/ssp.server.crt @@ -0,0 +1,22 @@ +-----BEGIN CERTIFICATE----- +MIIDdjCCAl6gAwIBAgIIWSBC+un/K/kwDQYJKoZIhvcNAQELBQAwPDELMAkGA1UE +BhMCTkExCzAJBgNVBAgMAk5BMQswCQYDVQQKDAJOQTETMBEGA1UEAwwKc3NwLnNl +cnZlcjAeFw0xOTA2MTgxNDA5MDRaFw0yOTA2MTUxNDA5MDRaMDwxCzAJBgNVBAYT +Ak5BMQswCQYDVQQIDAJOQTELMAkGA1UECgwCTkExEzARBgNVBAMMCnNzcC5zZXJ2 +ZXIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCsJImuJ0s68so1ZYTJ +ysav9FAplHR6nNX1csVD1lsERSZOHHQM2MJ3naIP0tQzgMwqEHBRqOIFnZcub10D +X0mfHU7a7+/EtKLAn/VEkTK7AextE4qh95JHtl0Xxg/KvXll6jT2Ain2TKDXt9q0 +2+23aZEed88tH0sQoERygsNbwlTQR51a9XmNNwJsK4wL8HnyyGoUs8s+uzF/wCCW +oWQJPmsbY6BYbAAFD/dJnlaS8QG4zyapJfXYzA+5EKu5+9FP4TLTrGQtJssUnAq7 +KwdVHu2T8VK5OIAOyjQjkosktWMpqe8DBF5+h/SPJmhd2y3+alR5CsYZcwOrCpiH +d7UrAgMBAAGjfDB6MB0GA1UdDgQWBBS8vk/IXDr1ofCcOiod2hrbCjsVlDAfBgNV +HSMEGDAWgBS8vk/IXDr1ofCcOiod2hrbCjsVlDAMBgNVHRMEBTADAQH/MAsGA1Ud +DwQEAwIDqDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwDQYJKoZIhvcN +AQELBQADggEBAELO/34ozB7d5GejKoxXOZb4xUcOrRb21I1pedV5+vW/yuBv71Hh +hcG/wzy3nczIv4EFcqU9MRU9ZihiY4culFazisc7L9Ca2bdwHetI8pN1GFVbc/+F +w8D7fI2Fo0ZXolmdXu49i4UrDLrIWTXddTqpcyp2yZdVEv9LGDzmYYa3UwA3NJjy +X8qAzyxe/yFW56i0fFzcrs4NRDfhwNEYIuIL8lTbWOAEU3NDClwycFwoQ05sWHlH +EuZ8AEi5BKpFIoYNWuXmgKGBMUTwwHZuFnCo4MfozxehiqTOQ8NIVtwoumfzmaXx +l/ICbFAZT5Fb4v1XC3xr9FOPGZkzklevzCs= +-----END CERTIFICATE----- + diff --git a/SSP-API-Demo/ssp.server.key b/SSP-API-Demo/ssp.server.key new file mode 100644 index 0000000..03c2af2 --- /dev/null +++ b/SSP-API-Demo/ssp.server.key @@ -0,0 +1,29 @@ +-----BEGIN PRIVATE KEY----- +MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCsJImuJ0s68so1 +ZYTJysav9FAplHR6nNX1csVD1lsERSZOHHQM2MJ3naIP0tQzgMwqEHBRqOIFnZcu +b10DX0mfHU7a7+/EtKLAn/VEkTK7AextE4qh95JHtl0Xxg/KvXll6jT2Ain2TKDX +t9q02+23aZEed88tH0sQoERygsNbwlTQR51a9XmNNwJsK4wL8HnyyGoUs8s+uzF/ +wCCWoWQJPmsbY6BYbAAFD/dJnlaS8QG4zyapJfXYzA+5EKu5+9FP4TLTrGQtJssU +nAq7KwdVHu2T8VK5OIAOyjQjkosktWMpqe8DBF5+h/SPJmhd2y3+alR5CsYZcwOr +CpiHd7UrAgMBAAECggEAT7dX3sMpjnHSfCm39W6m1eKwoKCz0/f/CPwOJ90DJxYS +qAd7IlvaqmPgIa3DQNp7MVuNd/NaP7l7wjAmBaLByCJdWvvTr+bqm4M3pHoM4RcB +8n0jLOAl6Hml4JWCyKM3rZ9oySe1YO6ZaWwlpq1WByKm5lIbKc0dCOT+7XxqlXnE ++L146JtZZkOJP0u81nSBvceYmvyn0xaPYsdrL2bDPaLJyLnkYIBHDOArxG8zeCBM +BqeSIXeaYQZ80TksozPp1QjG4pKQ/kKhzSxL04mNmel9tKLWCuAKpQbHnKW2qXbx +dD1OvR9JoG12GdAdJWOBlULljM1ds98pPwCqenxvyQKBgQDc5nb/NSS4FKB2/FjC +qA2eCeXd76xq8VVGw0m4klowXC3lMHU8OX75+oyDe0FiUHekaAbvcsYSmt3UOVyi +mi1yatnLFzw1VPW0uuCi+8JdMxH1gQYC6NW846iIDBqZy4gBGJSn0mdRWi8mXtpL +kViKxxEJ6BVUPoM2Fh66kh50/QKBgQDHfsS3+cO/pNTM9FcvPDZmTb3o/GtnBNf7 +cYacUy50u7//Qx++nmj3QLutDyVO02BAar2Y+eEokMhEUxKamDbKLrSOKfcs2vHd +bEe94696GVpqdm7jBOk9jeVQHnm2KDKHe9dQMfAFqZA2OeUPWVJ0twL1Y91omYxV +ifkj1Zc/RwKBgQC9XxmOiYmUAaLavlR9c8JQxJ16GLjP6Vo40rwFbfnBUZTK0TL/ +0S6IsQD6ypRv6xnWKJQhfFxPoNIg2JgQkWn6l51kXOPxuIb3S+m972Rdr6VquRRl +NCPfza8yCmZXiENs5Ryzjk2iUVTwaQptFAo61pNF0d9PHFQx7t6jBRb1JQKBgDwL +zg5KIT83z8145h0TlJQqZjUQdQtnC9NlEk1PRDZipKGihJWNfK6fT14BpwsY2GnL +NxIqdDkPixf1oS3jDurAMBxySTG5HP+2rclcFN89bleJGks+mS2r3g/FfID1jG/3 +OJGs1j/+D6giuO1rx0PWKg/OZUAsp26/vruoeIPVAoGBAJX4ztsF4T/ZWKRCBpSz +GqPun2R/jRLmBgp6B3yFpRXPA6LQmUPlYo+ifDCfxuJysFpvmRrH9KO6LDuA5ThR +i/Xoi5hyRCIxvCbIulaNuoPTPdV38xdj1gaX2OPq2QyHuoLpS/7CMWpDWJCoQQ/P +MU7q7HHgDgwERY1xbGr0izLi +-----END PRIVATE KEY----- + diff --git a/SSP-API-Demo/test.index.php b/SSP-API-Demo/test.index.php new file mode 100644 index 0000000..3f5918b --- /dev/null +++ b/SSP-API-Demo/test.index.php @@ -0,0 +1,79 @@ + +"; +sspapiOpenLibrary(); + +echo "
"; +sspapiPing(); + +echo "
"; +//sspapiResetCounter(); + +echo "
"; +sspapiInitSqrlCfgData(); + +echo "
"; +sspapiInitSqrlSystem(); + +echo "

"; + +$NutLen=16; +$MyArray = array( + "GET", // Method + "/nut.sqrl", // Path Info + isset($_SERVER['QUERY_STRING'])? $_SERVER['QUERY_STRING']: "", // Query String + isset($_SERVER['CONTENT_LENGTH'])? intval($_SERVER['CONTENT_LENGTH']): 0, // Data Length + "", // Data String + isset($_SERVER['HTTP_HOST'])? $_SERVER['HTTP_HOST']: "", // Http Host + isset($_SERVER['HTTP_REFERER'])? $_SERVER['HTTP_REFERER']: "", // Http Referrer + isset($_SERVER['REMOTE_ADDR'])? $_SERVER['REMOTE_ADDR']: "", // Remote Address + isset($_SERVER['HTTP_ORIGIN'])? $_SERVER['HTTP_ORIGIN']: "", // Http Origin + isset($_SERVER['SERVER_PORT'])? $_SERVER['SERVER_PORT']: "" // Server Port +); +$Return=sspapiSendRequest($MyArray); +echo "

"; + +$NutEq=substr($Return[1], 0, $NutLen); +printf("Returned Headers (len=%d):
%s", strlen($Return[0]), $Return[0]); +echo "

"; + +$Len=$Return[2]; +$Data=substr($Return[1], 0, $Len); +printf("Returned Data (len=%d):
", $Len); +print_r($Data); +echo "

"; + +$MyArray = array( + "GET", // Method + "/png.sqrl", // Path Info + $NutEq, // Query String + isset($_SERVER['CONTENT_LENGTH'])? intval($_SERVER['CONTENT_LENGTH']): 0, // Data Length + "", // Data String + isset($_SERVER['HTTP_HOST'])? $_SERVER['HTTP_HOST']: "", // Http Host + isset($_SERVER['HTTP_REFERER'])? $_SERVER['HTTP_REFERER']: "", // Http Referrer + isset($_SERVER['REMOTE_ADDR'])? $_SERVER['REMOTE_ADDR']: "", // Remote Address + isset($_SERVER['HTTP_ORIGIN'])? $_SERVER['HTTP_ORIGIN']: "", // Http Origin + isset($_SERVER['SERVER_PORT'])? $_SERVER['SERVER_PORT']: "" // Server Port +); +$Return=sspapiSendRequest($MyArray); +echo "

"; + +$NutEq=substr($Return[1], 0, $NutLen); +printf("Returned Headers (len=%d):
%s", strlen($Return[0]), $Return[0]); +echo "

"; + +$Len=$Return[2]; +$Data=substr($Return[1], 0, $Len); +printf("Returned Data (len=%d):
", $Len); +print_r($Data); +echo "

"; + +sspapiCloseLibrary(); +echo "

"; + +?> + diff --git a/SSP-API-Demo/web.server.crt b/SSP-API-Demo/web.server.crt new file mode 100644 index 0000000..275924f --- /dev/null +++ b/SSP-API-Demo/web.server.crt @@ -0,0 +1,22 @@ +-----BEGIN CERTIFICATE----- +MIIDdjCCAl6gAwIBAgIIY4TMnesvp+IwDQYJKoZIhvcNAQELBQAwPDELMAkGA1UE +BhMCTkExCzAJBgNVBAgMAk5BMQswCQYDVQQKDAJOQTETMBEGA1UEAwwKd2ViLnNl +cnZlcjAeFw0xOTA2MTgxNDA1MjJaFw0yOTA2MTUxNDA1MjJaMDwxCzAJBgNVBAYT +Ak5BMQswCQYDVQQIDAJOQTELMAkGA1UECgwCTkExEzARBgNVBAMMCndlYi5zZXJ2 +ZXIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDPsZqACXTv1VLoSZLy +8klJa/PY1guCD/P8feDVPnDEo0g5msx3NTL4/oDE/NqMC3oBfapc+76yuEcAH2oK +bndswwYAoF47yKttwJVlJIaNeCgVPCoODDLG79chvUFHd3QI4yof/RCDqZnXx+mp +W+VUMFKT84WeQtIzngwaJISEbRwfTPAuj4wdxGm3JCOLKoXZmnFG8BkNp5eWGwIV +qc/YVNiMPuTpgYybwe4xG3EeOlId5jU1H/5QL2F/0F1NHFM/rEthvXs/cUFGiZHA +tdVIDMYqmWYOEQZk+m7RC1DAGESMYzKuhonHCi6v9Itg8giScvcAB+FAOwUQOHi6 +9uJFAgMBAAGjfDB6MB0GA1UdDgQWBBTSZs4FKd9F7+GTaZPZ09LKGqmMcjAfBgNV +HSMEGDAWgBTSZs4FKd9F7+GTaZPZ09LKGqmMcjAMBgNVHRMEBTADAQH/MAsGA1Ud +DwQEAwIDqDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwDQYJKoZIhvcN +AQELBQADggEBACPWOGu8SPpUnHMq5ukNKIa2yUYFQR4C+yc0TPAxfGE/vtBZ0X7l ++W1lrEvQgkIeshcGrtuv5Oy8h5WksFYBAS7I1Q1tRA1GYo5LjZbvAWZ7NtTMjgGk +d7Jwphp2V6gQfvDLUs2flATDk4aS51LbPBjaTRh49lR/WdQG0yHjTgNGLlpP5ncz +lYUU4TmeHUtvKh4q3fgGSZGjqr2WuV9D/Z4ANPuy5wXe7KZfVnzKDW+wwOhG02cc +X+tuHHYWmSbiMmP7xB72C9WA/fVtNAOKl0hpWZLLdEXVJ1wSh6Cv7P0OPtmaHiv4 +uvOEJuLXAeup6H0lHjjtrM63WnwUoKvUGYM= +-----END CERTIFICATE----- + diff --git a/SSP-API-Demo/web.server.key b/SSP-API-Demo/web.server.key new file mode 100644 index 0000000..56f6f19 --- /dev/null +++ b/SSP-API-Demo/web.server.key @@ -0,0 +1,29 @@ +-----BEGIN PRIVATE KEY----- +MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDPsZqACXTv1VLo +SZLy8klJa/PY1guCD/P8feDVPnDEo0g5msx3NTL4/oDE/NqMC3oBfapc+76yuEcA +H2oKbndswwYAoF47yKttwJVlJIaNeCgVPCoODDLG79chvUFHd3QI4yof/RCDqZnX +x+mpW+VUMFKT84WeQtIzngwaJISEbRwfTPAuj4wdxGm3JCOLKoXZmnFG8BkNp5eW +GwIVqc/YVNiMPuTpgYybwe4xG3EeOlId5jU1H/5QL2F/0F1NHFM/rEthvXs/cUFG +iZHAtdVIDMYqmWYOEQZk+m7RC1DAGESMYzKuhonHCi6v9Itg8giScvcAB+FAOwUQ +OHi69uJFAgMBAAECggEAcRr9UoDT59A6iDmZByke9BcQAqP+PGRHsNc0W6zXaJ6r +NIOymbClA6hFpAE3W1DcrncrEdwe6+Ei+VQiQXALJXXHjQvIhbIweWKJeT088Ung +OkA7fs7x0BjJBZy1MiBBVp2vUSBVn/36w+Igw5RB/Wkbb2sM9zTYmDeXy5zbdemi +GqOUKOeOxWl7a7tqA12rtXA0zzP8Z1uuwiyUspwauvkG9MQPGSjI1q/fd7p8hGpi +M8/v4lMx7rZi85COW6fjInF7y+QRjVG04Luj2K+tfp6qJcyA+L+tU7lkGH7mZuSQ +E/AdYBrkYlLLA2yYZhoitCeb9Uj81ToG/LADdRsDAQKBgQDx0Ew21iUQtQMfJzkz +yKMI/66B+TDr2HkKY3kfYA+eWh+tOq3vSudYtuUOolmj9baY+sat285RATg/LmpP +WvtR8FbV05J+74bw5xhmrZXopC4iqFLouSb4kPXkcZXPO5rKY6htCy/J/GdBZ23U +3ZhOkc1ec7QG9CZMq6P3sPEE5QKBgQDb4N9r+aoM6Ubfegx+PH/GvQBN0VlabiXx +ecNrcdAYVlBa3KfI1nODIR/LjFU7IFhor08SnZjb2MS2DQfCqGPWGR3leJfGAOd4 +2nexARwfF41+XUmN1a1XnNpoiDVJsx8L5N9uK58iZULJUSLwggqL7ABGTCqi8yGO +5lvlCQ7x4QKBgEYRY2QoXQkgSk1Gok6c/pDm9Xv35vMQANK/zCMJRL1PxAoADNJf +0/Vi2bCJ3ouh8U0WrWdHX9sdDV1RZ8CizlwJ1j+TVMmvQlyfufRWrC+DE1M7jvqc +W+x+pKGTQCOSU+H9Spp+OVS/7HOJMswRgcaSfP23bRzutgJVYeetv8j5AoGAEzbY +b1gW6x/riJXix5lD1Tso7qPvuf5MJIjucdI1TBsm1HnZ06wh1gCsBZ6SyCLwdt1y +/H53ICcWMY578h/C8a+qNCZQpQXpNF9q/DXLnk/xlmxShCl7B1/2mhHlDjav7Nso +Rzlao6fTqUIE2p2SjF2oPHxlcW3rrdAlkaM0AiECgYEApzuka9ykvlvxR9NL+rcT +eR6gQeTNpIRsNM2mNBitfaqNgG8fJDHXCNvWpryaQ8bJ5ijUZLU4wLMvWaYxb6hy +tXsmGXslSwpvPmZ9ep4/lyurM/Ac5rWaygjMNquA6vmeBQOeJZ+4wca1BBAkdm/n +Bem0cXzQtKZ+ufSHvVp79gM= +-----END PRIVATE KEY----- + diff --git a/SSP-API-Source/base64url.c b/SSP-API-Source/base64url.c new file mode 100644 index 0000000..8c462cc --- /dev/null +++ b/SSP-API-Source/base64url.c @@ -0,0 +1,198 @@ + +// base64url.c + +#include "global.h" + +// Encoding: + +const char b64urlchars[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"; + +// Decoding: "-..0123456789.......ABCDEFGHIJKLMNOPQRSTUVWXYZ...._.abcdefghijklmnopqrstuvwxyz" + +int b64urlbytes[]={62, -1, -1, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, + -1, -1, -1, -1, -1, -1, -1, 0, 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, + -1, -1, -1, -1, 63, -1, 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}; + +int GetBase64urlEncodedSize(int len) { + // we do not pad with '=' or '==' or null-terminate + // #bytes: 1 2 3 4 5 6 7 8 9 + // #chars: 2 3 4 6 7 8 10 11 12 + return 4*(len-1)/3+2; +} + +int GetBase64urlDecodedSize(int len) { + // we do not pad with =' or '==' or null-terminate + // #chars: 2 3 4 6 7 8 10 11 12 + // #bytes: 1 2 3 4 5 6 7 8 9 + return ((len-1)/4)*3 + (len-1)%4; +} + +int b64_isvalidchar(char c) { + if(c<'-' || c>'z' || b64urlbytes[c-45]==-1) { + // Invalid Base64url character + return 0; + } + else { + // Valid Base64url character + return 1; + } +} + +/* +Three 8-bit bytes encode into four 6-bit base 64 characters + +3n+0 bytes require 4n+0 characters +3n+1 bytes require 4n+2 characters +3n+2 bytes require 4n+3 characters + +Note that 4n+1 characters is not a valid encoding +*/ + +int Base64urlEncode(const unsigned char *in, int len, char *out, int siz) { + // in = pointer to input byte array + // len = length of input byte array + // out = pointer to output character array + // siz = size of the output array + // the output array is not null-terminated + // we do not pad the output array with '=' or '==' + + int i; + int j; + int n; + + if(in==NULL || len==0 || out==NULL || siz==0){ + // ERROR: invalid function parameter(s) + return 0; + } + + n=GetBase64urlEncodedSize(len); + if(siz < n) { + // ERROR: client-provided array is too small + return 0; + } + + int len3=(len/3)*3; // length rounded down to a multiple of 3 + int a, b, c, d; + + for (i=0, j=0; i>2; + b=in[i+0]<<4 | in[i+1]>>4; + c=in[i+1]<<2 | in[i+2]>>6; + d=in[i+2]; + out[j+0]=b64urlchars[a&0x3f]; + out[j+1]=b64urlchars[b&0x3f]; + out[j+2]=b64urlchars[c&0x3f]; + out[j+3]=b64urlchars[d&0x3f]; + } + if(len%3==1) { + a=in[i+0]>>2; + b=in[i+0]<<4; + out[j+0]=b64urlchars[a&0x3f]; + out[j+1]=b64urlchars[b&0x3f]; + } + if(len%3==2) { + a=in[i+0]>>2; + b=in[i+0]<<4 | in[i+1]>>4; + c=in[i+1]<<2; + out[j+0]=b64urlchars[a&0x3f]; + out[j+1]=b64urlchars[b&0x3f]; + out[j+2]=b64urlchars[c&0x3f]; + } +//[ +LOG("in:"); +LOG("[]", in, len); +LOG("out:"); +LOG("[c]", out, n); +//] + return n; +} +SQ_DWORD SqrlCvrtToBase64(SQ_CHAR *pOut, SQ_DWORD SizOut, const SQ_BYTE *pIn, SQ_DWORD LenIn) { + BEG("SqrlCvrtToBase64()"); + SQ_DWORD LenOut=Base64urlEncode(pIn, LenIn, pOut, SizOut); + END(); + return LenOut; +} + +int Base64urlDecode(const char *in, int len, unsigned char *out, int siz) { + // in = pointer to input char array + // len = length of input char array + // out = pointer to output byte array + // siz = size of the output array + // the input array is not null-terminated + // we do not pad the input array with '=' or '==' + int i, j; + + if(in==NULL || len==0) return 0; + if(out==NULL || siz==0) return 0; + + if(len%4==1) return 0; + for (i=0; i>4; + out[j+1]=b<<4 | c>>2; + out[j+2]=c<<6 | d; + } + // Decode any partial block + if(len%4>1) { + a=b64urlbytes[in[i+0]-45]; + b=b64urlbytes[in[i+1]-45]; + out[j+0]=a<<2 | b>>4; + } + if(len%4>2) { + c=b64urlbytes[in[i+2]-45]; + out[j+1]=b<<4 | c>>2; + } + return n; +} +SQ_DWORD SqrlCvrtFromBase64(SQ_BYTE *pOut, SQ_DWORD SizeOut, const SQ_CHAR *pIn, SQ_DWORD LengthIn) { + BEG("SqrlCvrtFromBase64()"); + SQ_DWORD LenOut=Base64urlDecode(pIn, LengthIn, pOut, SizeOut); + END(); + return LenOut; +} + +SQ_DWORD CvrtToBase64String(SQ_CHAR *pOut, SQ_DWORD SizOut, const SQ_BYTE *pIn, SQ_DWORD LenIn) { + BEG("CvrtToBase64String()"); + SQ_DWORD LenOut=Base64urlEncode(pIn, LenIn, pOut, SizOut); + pOut[LenOut]='\0'; + END(); + return LenOut; +} +/* +============================================================================ + DECODE BASE64SZ AND STORE + -------------------------------------------------------------------------- + Given a null-terminated Base64 string, this decodes it and places + the resulting data into a Global Alloc, stored in the provided ptr. +---------------------------------------------------------------------------- +*/ +void DecodeBase64szAndStore(SQ_BYTE **ppszDecoded, const SQ_CHAR *pBase64sz) { + BEG("DecodeBase64szAndStore()"); + + int len=strlen(pBase64sz); + int siz=GetBase64urlDecodedSize(len); + *ppszDecoded=(SQ_BYTE *)GlobalAlloc(siz+1); + + // Note: GlobalAlloc initializes with zeros + // so szDecoded will be null-terminated automatically + + SqrlCvrtFromBase64(*ppszDecoded, siz, pBase64sz, len); + + END(); +} diff --git a/SSP-API-Source/browser.c b/SSP-API-Source/browser.c new file mode 100644 index 0000000..725210c --- /dev/null +++ b/SSP-API-Source/browser.c @@ -0,0 +1,533 @@ + +// browser.c - API for Web Browser to SSP Server + +/* +via HTTPS GET + +/nut.sqrl +/png.sqrl?{ 12-char nut } +/pag.sqrl?{ 12-char nut } +*/ + +#include "global.h" + +/* +=============================================================================== + GET STRING IN GLOBAL ALLOC + in: pString + ret: +=============================================================================== +*/ +SQ_CHAR *GetStringInGlobalAlloc(SQ_CHAR *pString) { + // get the string's length + // allocate a buffer for it + // copy the string into the alloc + // return the buffer pointer (our alloc) + return strcpy((SQ_CHAR *)GlobalAlloc(strlen(pString)+1), pString); +} +/* +=============================================================================== + GetQueryParamNut + in: pSCB->lpszQueryString + out: pszNutBuffer +------------------------------------------------------------------------------- +The QueryString looks like "nut=<12 character base64url encoded nut>..." +We extract and return "<12 character base64url encoded nut>" +szNutEquals is "nut=" +SQRL_NUT_LEN is 12 +*/ +void GetQueryParamNut(SQ_CHAR *pszNutBuffer, SQRL_CONTROL_BLOCK *pSCB) { + BEG("GetQueryParamNut()"); + + pszNutBuffer[0]='\0'; + + if(pSCB->lpszQueryString==NULL) { + END(); + return; + } + + int nPrefixLen=strlen(pszNutEquals); // 4 + + if(strlen(pSCB->lpszQueryString)lpszQueryString, pszNutEquals); + if(ptr==NULL) { + END(); + return; + } + + SQ_CHAR *pNut=&ptr[nPrefixLen]; + if(strlen(pNut)>=SQRL_NUT_LEN){ + memcpy(pszNutBuffer, pNut, SQRL_NUT_LEN); + pszNutBuffer[SQRL_NUT_LEN]='\0'; + } +//[ +LOG("pszNutBuffer: %s", pszNutBuffer); +//] + END(); +} + +/* +=============================================================================== + SET LOGIN PAGE URL + in: pSCB + out: pPendingAuth->pszLoginPageURL +=============================================================================== +*/ +void SetLoginPageUrl(PENDING_AUTHS *pPendingAuth, SQRL_CONTROL_BLOCK *pSCB) { + BEG("SetLoginPageUrl()"); + SQ_CHAR szEncodedReferrer[2048]; + + // Encode the referrer to base 64 url + GetUrlEncodedReferrer(szEncodedReferrer, sizeof(szEncodedReferrer), pSCB); + + // Has the login page not been registered or has it changed? + if(pPendingAuth->pszLoginPageURL==NULL || + strcmp(szEncodedReferrer, pPendingAuth->pszLoginPageURL)!=0) { + + // release any previous alloc + GlobalFree((void **)&pPendingAuth->pszLoginPageURL); + + // assign the new alloc + pPendingAuth->pszLoginPageURL=GetStringInGlobalAlloc(szEncodedReferrer); + } + + LOG("pPendingAuth->pszLoginPageURL: %s", pPendingAuth->pszLoginPageURL); + END(); +} + +//=============================================================================== +// SET PATH EXTENSION STRING +//=============================================================================== +SQ_VOID SetPathExtensionString(SQ_CHAR *pszPathExtension, SQRL_CONTROL_BLOCK *pSCB) { + // if we had a query, let's check to see whether it begins with a digit + char *pszQuery=pSCB->lpszQueryString; + if(pszQuery!=NULL && pszQuery[0]>='1' && pszQuery[0]<='9') { + // we setup "x=n&" and transpose that digit + sprintf(pszPathExtension, "%s%c&", pszPathPrefix, pszQuery[0]); + } +} + +//=============================================================================== +// PREP PENDING AUTH OBJECT +//=============================================================================== +PENDING_AUTHS *PrepPendingAuthObject(SQRL_CONTROL_BLOCK *pSCB) { + BEG("PrepPendingAuthObject()"); + + PENDING_AUTHS *pPendingAuth=(PENDING_AUTHS *)GlobalAlloc(sizeof(PENDING_AUTHS)); + pPendingAuth->QueueObject.TimeStamp=GetSystemOneSecondTime(); + + // get /nut.sqrl?n parameter (if present) + SetPathExtensionString(pPendingAuth->szPathExtension, pSCB); + GetUnique12charNut(pPendingAuth->aBrowserNut, SQ_FALSE); + memcpy(pPendingAuth->aProtocolNut, pPendingAuth->aBrowserNut, SQRL_NUT_LEN); + + // Concatenate two 12-char "nuts" to make the CPS nonce + SQ_CHAR *pHi=&pPendingAuth->aCPSNonce[0]; + GetUnique12charNut(pHi, SQ_FALSE); + SQ_CHAR *pLo=&pPendingAuth->aCPSNonce[12]; + GetUnique12charNut(pLo, SQ_FALSE); + + ObtainClientConnectionIP(pPendingAuth->aRequestIP, pSCB); + SetInitialAuthMacs( pPendingAuth, pSCB); + SetLoginPageUrl(pPendingAuth, pSCB); + + // return our object to our caller + END(); + return pPendingAuth; +} + +/* +=============================================================================== + SUBMIT CPS AUTH +------------------------------------------------------------------------------- + This query is invoked by a browser redirect to this SQRL service provider in + response to a successful CPS-style authentication. It carries the secret CPS + key which the client received from this service to confirm the browser's ID. + + /cps.sqrl?{-SQRL-server-provided-CPS-nonce-} + + This code looks up the pending auth item in the "PendingAuthsQueue" in-memory + list using the caller's session cookie as its key. It captures ;the browser's + session cookie and the authenticated SQRL public key from the pending queue, + then checks to see whether the caller's CPS matches what we expect for this + authentication. And, in either event, the pending auth is deleted from the + system. In the event of successful CPS match, we call out to the web server,g + providing it the browser's now-authenticated session cookie, the SQRL identity + of the authenticator (which it regards as an opaque token) and the web server + account identity previously associated with this SQRL identity, if any. The + web server returns the URL of the page the waiting browser should be referred + to now that its session is authenticated and its identities are known. +------------------------------------------------------------------------------- +*/ +SQ_VOID SubmitCpsAuth(SQRL_CONTROL_BLOCK *pSCB) { + BEG("SubmitCpsAuth()"); + PENDING_AUTHS AuthedAuth; + SQ_CHAR *pszLoginPageURL=(char *)pszNull; + SQRL_ASSOCIATIONS SqrlDB; + SQ_CHAR szOptionsValue[32]; + SQ_CHAR szResponseString[1024]; + ASSOC_REC_DATA *pAssocRecData=&SqrlDB.AssocRecData; + + if(pSCB->lpszQueryString==NULL || strlen(pSCB->lpszQueryString)!=CPS_TOKEN_LEN) { + // if we failed, return a 404 + Return404NotFound(pSCB); + END(); + return; + } + + // scan the PendingAuthsQueue looking for our target CPS nonce + +LOG("owner: %u", PendingAuthsQueue.CriticalSection.Lock.__data.__owner); +LOG("&Lock: %p", &PendingAuthsQueue.CriticalSection.Lock); + + EnterCriticalSection(&PendingAuthsQueue.CriticalSection); + +LOG("owner: %u", PendingAuthsQueue.CriticalSection.Lock.__data.__owner); +LOG("&Lock: %p", &PendingAuthsQueue.CriticalSection.Lock); + + PENDING_AUTHS *pPendingAuth; + // AuthedAuth is our authenticated pending auth + pPendingAuth=LookupByCPS(&AuthedAuth, pSCB->lpszQueryString, /*Update*/SQ_FALSE); + if(pPendingAuth != NULL) { + // We found the CPS nonce. Since this CPS query from the hosting + // server always represents the conclusion of a SQRL authentication, + // we delete the Pending Auths object from our in-memory queue after + // getting a local copy. + if(pPendingAuth->pszLoginPageURL!=NULL) { + pszLoginPageURL=pPendingAuth->pszLoginPageURL; + } + pPendingAuth->pszLoginPageURL=NULL; + + DeletePendingAuthObject(pPendingAuth); + LeaveCriticalSection(&PendingAuthsQueue.CriticalSection); + } + else { + LeaveCriticalSection(&PendingAuthsQueue.CriticalSection); + Return404NotFound(pSCB); // if we failed, return a 404 + GlobalFree((void **)&pszLoginPageURL); + END(); + return; + } + + // the hosting web server submitted a query for the auth info using a + // valid one-time CPS token. So we use the authenticated SqrlUser to + // lookup any Sqrl association record + + if(GetRecordBySqrlID(&SqrlDB, AuthedAuth.szSqrlPublicKey)!=SQ_PASS) { + Return404NotFound(pSCB); // if we failed, return a 404 + GlobalFree((void **)&pszLoginPageURL); + END(); + return; + } + // convert the "OptionsValue" param into an szString for (stat=) + + SQ_DWORD OptVal; + SQ_DWORD *pOptVal; + szOptionsValue[0]='\0'; + + OptVal=AuthedAuth.OptionsValue; + if((OptVal&OPT_SQRLONLY)==OPT_SQRLONLY) { + strcat(szOptionsValue, pszSqrlOnly); + } + if((OptVal&OPT_HARDLOCK)==OPT_HARDLOCK) { + if(szOptionsValue[0]!='\0') strcat(szOptionsValue, pszComma); + strcat(szOptionsValue, pszHardLock); + } + + pOptVal=&SqrlDB.AssocRecData.SqrlOptionFlags; + OptVal=*pOptVal; + if((OptVal&AUTH_DISABLED)==AUTH_DISABLED) { + if(szOptionsValue[0]!='\0') strcat(szOptionsValue, pszComma); + strcat(szOptionsValue, pszDisabled); + } + if((OptVal&REMOVE_REQUESTED)==REMOVE_REQUESTED) { + if(szOptionsValue[0]!='\0') strcat(szOptionsValue, pszComma); + strcat(szOptionsValue, pszRemove); + // we only report the deletion command once. so we turn + // the bit off and save the update after reporting it once + *pOptVal&=(!REMOVE_REQUESTED); + StoreSqrlRecord(&SqrlDB); + } + if((OptVal&USER_REKEYED)==USER_REKEYED) { + if(szOptionsValue[0]!='\0') strcat(szOptionsValue, pszComma); + strcat(szOptionsValue, pszRekeyed); + // we only report the rekeying once. so we turn + // the bit off and save the update after reporting it once + *pOptVal&=(!USER_REKEYED); + StoreSqrlRecord(&SqrlDB); + } + + // now we form the value of the "SQRL-Auth:" query header + if(strlen(pAssocRecData->szAccount)>0) { + sprintf(szResponseString, pszUserIdWithAccount, &SqrlDB.szSqrlUser, &szOptionsValue, pszLoginPageURL, &pAssocRecData->szAccount); + } + else { + // the SQRL ID has not yet been associated with an account, + // so we return the session and the SQRL ID... + sprintf(szResponseString, pszUserIdWithNoAccount, &SqrlDB.szSqrlUser, &szOptionsValue, pszLoginPageURL); + } + + LogTheQueryAndReply(szResponseString, pSCB); + ReturnStringToCaller(szResponseString, pSCB); + + GlobalFree((void **)&pszLoginPageURL); + LOG("szResponseString: %s", szResponseString); + END(); +} + +/* +=============================================================================== + TRIGGER NON CPS AUTH +------------------------------------------------------------------------------- + We come here when we have successfully authenticated without CPS. So we need + to place a URL into the "NextPageURL" which the periodic query for /pag.sqrl + will pickup and jump the user's browser to. That NextPageURL should be a CPS + style query which INCLUDES the CPS nonce which only we know. When the browser + jumps there, will be identical to the browser being redirected from the local + client for a full CPS auth... so we'll then redirect to the Webserver. +=============================================================================== +*/ +void TriggerNonCpsAuth(PENDING_AUTHS *pPendingAuth, SQRL_CONTROL_BLOCK *pSCB) { + BEG("TriggerNonCpsAuth()"); + SQ_CHAR szUrlBuffer[2048]; + + PlaceCpsUrlIntoBuffer(szUrlBuffer, pPendingAuth); + + // now we place the string into an alloc for use and later release + GlobalFree((void**)&pPendingAuth->pszNextPageURL); + pPendingAuth->pszNextPageURL=GetStringInGlobalAlloc(szUrlBuffer); + + // the next time the browser JavaScript probes for a next page it will + // be directed to our /cps.sqrl handler with the proper CPS nonce for + // the auth... so it will succeed. + + END(); +} + +/* +=============================================================================== + GET SESSION NUT +------------------------------------------------------------------------------- + /nut.sqrl +------------------------------------------------------------------------------- + This query may be invoked by JavaScript running on a site's login/registration + pages offering SQRL login ==OR== by the hosting server if it wishes to provide + the NUT directly bound into the provided pages. If page-based JavaScript uses + an XHR request, the data is then appended to the page's sqrl:// invocation HREF. + + The handler below creates or references an item in the "PendingAuthsQueue" + in-memory list using the caller's session cookie as its key. If a new item is + created, a guaranteed unique 12-character nut is also created and associated + with the caller's session cookie. And in any event, we receive that 12-char + nut and base64url-encoded cancellation URL... which we return to our caller. +------------------------------------------------------------------------------- + {12-char-nut}&can={-base64url-} +------------------------------------------------------------------------------- +*/ +SQ_VOID GetSessionNut(SQRL_CONTROL_BLOCK *pSCB) { + BEG("GetSessionNut()"); + SQ_BYTE szNutBuffer[16]; + SQ_CHAR szEncodedReferrer[2048]; + SQ_CHAR szQueryReply[2048]; + SQ_CHAR *pszPathExt; + + // create a new Pending Auth object with a new Browser Nut for queries + + PENDING_AUTHS *pPendingAuth=PrepPendingAuthObject(pSCB); + + Enqueue(&PendingAuthsQueue, (QUEUE_OBJECT *)pPendingAuth); + + // create a null-terminated version of the 12-char nut for output + memcpy(szNutBuffer, pPendingAuth->aBrowserNut, SQRL_NUT_LEN); + szNutBuffer[SQRL_NUT_LEN]='\0'; +//[ +LOG("szNutBuffer: %s", szNutBuffer); +//] + pszPathExt=pPendingAuth->szPathExtension; + + // Set our 'can={--}' value to the page referrer + GetUrlEncodedReferrer(szEncodedReferrer, sizeof(szEncodedReferrer), pSCB); +//[ +LOG("szEncodedReferrer: %s", szEncodedReferrer); +//] + sprintf(szQueryReply, pszNutAndCanLinkFormat, pszPathExt, szNutBuffer, szEncodedReferrer); + + ReturnStringToCaller(szQueryReply, pSCB); + LogTheQueryAndReply(szQueryReply, pSCB); + +//[ +LOG("PA.QueueObject.TimeStamp: %u", pPendingAuth->QueueObject.TimeStamp); +LOG("szQueryReply: %s", szQueryReply); +//] + + END(); +} + +/* +=============================================================================== + GET QR CODE +------------------------------------------------------------------------------- + This query is invoked by a site's login/registration pages which display a + SQRL QR code: + /png.sqrl?nut={12-char Nut}&can={encoded cancel} + + This code references or creates an item in the "PendingAuthsQueue" in-memory + list using the caller's session cookie as its key. If a new item is created, + a guaranteed unique 12-character nut is also created and associated with the + caller's session cookie. And in any event, we receive that 12-character nut + in response to the call to "InitPendingAuthAndReturnNut" which we combine + into a SQRL query of the form: + + sqrl://{hostname}/sqrl?nut=abcdefghijkl + + ...which is encoded into a standard QR code image and returned to our caller. +------------------------------------------------------------------------------- +*/ + +SQ_VOID GetQRcode(SQRL_CONTROL_BLOCK *pSCB) { + BEG("GetQRcode()"); + SQ_CHAR szNutBuffer[16]; + SQ_CHAR szQRdata[512]; + SQ_CHAR *pszPathExt; + + GetQueryParamNut(szNutBuffer, pSCB); + + // now we lock the queue and find our pending auth object by its nut + EnterCriticalSection(&PendingAuthsQueue.CriticalSection); + PENDING_AUTHS *pPendingAuth=LookupByNut(NULL, szNutBuffer, /*UpdateObject=*/SQ_FALSE, /*ProtocolNut=*/SQ_FALSE, pSCB); + + // we want to grab this pending auth's path extension value + pszPathExt=(char *)pszNull; + if(pPendingAuth!=NULL) { + pszPathExt=pPendingAuth->szPathExtension; + } + + // and quickly unlock the pending auths queue + LeaveCriticalSection(&PendingAuthsQueue.CriticalSection); + + // now we obtain the Hostname our caller used for this query + // so we can embed it into the QR code we're going to display + // now we form our QR code string using: 'sqrl://%s/sqrl?%snut=%s' + +//[ +// To Do ! +//. check if lpszHttpHost is NULL and return HSE_STATUS_ERROR if it is (can it be?) +//] + sprintf(szQRdata, pszQRcodeFormat, pSCB->lpszHttpHost, pszPathExt, szNutBuffer); + + // and this final string is bound into a QR code image and returned + SendStringAsQRcodeImage(pSCB, szQRdata); + + // log our return of a PNG image + LogTheQueryAndReply(szQRdata, pSCB); + END(); +} + +/* +=============================================================================== + GET NEXT PAGE +------------------------------------------------------------------------------- + This query is invoked by JavaScript running on a site's login/registration + pages offering SQRL login. The JavaScript uses an AJAX-style XMLHttpRequest + to request the URL of the page, if any, that it should change to: + + /pag.sqrl?nut={12-char Nut}&can={encoded cancel} + + This code looks up an item in the "PendingAuthsQueue" in-memory list using the + caller's session cookie as its key. If a matching item is found which also + contains a non-null 'pszNextPageURL' this signifies that the authentication + succeeded and is providing the caller with its next page. So the pending auth + object is deleted from the system and the URL is returned to the caller. +------------------------------------------------------------------------------- +*/ + +SQ_VOID GetNextPage(SQRL_CONTROL_BLOCK *pSCB) { + BEG("GetNextPage()"); + SQ_CHAR szNutBuffer[16]; + + GetQueryParamNut(szNutBuffer, pSCB); + + // now we lock the queue and find our pending auth object by its nut + EnterCriticalSection(&PendingAuthsQueue.CriticalSection); + + PENDING_AUTHS *pPendingAuth=LookupByNut(NULL, szNutBuffer, /*UpdateObject=*/SQ_FALSE, /*ProtocolNut=*/SQ_FALSE, pSCB); + + if(pPendingAuth==NULL) { + // if this is a query for a non-existant nut, it's NEVER going + // to be found. So we release the lock and return a "410 GONE" + // HTTP status. The querying page can then refresh itself to + // obtain a new nut + LeaveCriticalSection(&PendingAuthsQueue.CriticalSection); + Return410Gone(pSCB); + + END(); + return; + } + + // we found the matching nut. so let's check to see whether a next page + // for us to jump to has been registered? since we will ALWAYS release + // this alloc if it's NOT zero (see below) we need to show that it is + // no longer allocated, so we get it and ZERO it at the same time + + SQ_CHAR *pNextPageURL=pPendingAuth->pszNextPageURL; + pPendingAuth->pszNextPageURL=NULL; + + // we also take this occasion to update the szLoginPageURL + // so that when we DO jump, we'll be jumping to the latest. + SetLoginPageUrl(pPendingAuth, pSCB); + + // and now we can unlock the pending auths queue + LeaveCriticalSection(&PendingAuthsQueue.CriticalSection); + + // now we either direct the caller to the registered page, or return a + // 404 Not Found if we either have NO pending auth or NO registered page. +//[ +LOG("pNextPageURL: %p %s", pNextPageURL, pNextPageURL); +//] + if(pNextPageURL!=NULL) { + LogTheQueryAndReply(pNextPageURL, pSCB); + ReturnStringToCaller(pNextPageURL, pSCB); + GlobalFree((void **)&pNextPageURL); + } + else { + Return404NotFound(pSCB); + } + + END(); +} + +SQ_RCODE ListSupersededIDs(SQRL_CONTROL_BLOCK *pSCB) { + BEG("ListSupersededIDs"); + char *pszList=GetSupersededIDs(); + ReturnStringToCaller(pszList, pSCB); + GlobalFree((void **)&pszList); + + END(); + return SQ_PASS; +} + +SQ_RCODE ListPendingAuths(SQRL_CONTROL_BLOCK *pSCB) { + BEG("ListPendingAuths"); + char *pszList=GetPendingAuths(); + ReturnStringToCaller(pszList, pSCB); + GlobalFree((void **)&pszList); + + END(); + return SQ_PASS; +} + +SQ_RCODE ListDatabase(SQRL_CONTROL_BLOCK *pSCB) { + BEG("ListDatabase"); + + char *pszList=GetBerkeleyMainDatabase(); + ReturnStringToCaller(pszList, pSCB); + GlobalFree((void **)&pszList); + + END(); + return SQ_PASS; +} + diff --git a/SSP-API-Source/client.c b/SSP-API-Source/client.c new file mode 100644 index 0000000..221db96 --- /dev/null +++ b/SSP-API-Source/client.c @@ -0,0 +1,1128 @@ + +// client.c + +/* +via HTTPS POST +/cli.sqrl +*/ + +/* +=============================================================================== + SQRL CLIENT PROTOCOL IMPLEMENTATION +=============================================================================== +*/ + +#include "global.h" + +/* +============================================================================ + COMMAND AND OPTION PARSER +---------------------------------------------------------------------------- +*/ +void CommandOptionParser(SQ_DWORD *pResultFlags, const CMD_OPT_TABLE ArgsTable[], int NumItems, SQ_CHAR *pszArgList) { + BEG("CommandOptionParser()"); + + // Find the command in CommandTable or the options in OptionsTable + *pResultFlags=0; + + // we assume pszArgs is null-terminated and args end with '~' or '\r' + // for commands there should be just one ending in CR LF e.g. query\r\n + // for options they will be separated by "~" and end with CR LF e.g. suk~cps\r\n + + // Scan pszArgLst for args, pBeg, pEnd will designate an arg + // query\r\n suk~cps\r\n + // pBeg: ^ ^ ^ ^ ^ + // pEnd: ^ ^ ^ + char *pBeg; + char *pEnd; + char c; + + pEnd=pszArgList; + while(1) { + // pBeg points to the first char of a possible command or option + // we increment pEnd to point to the last char + pBeg=pEnd; + while(1) { + c=*pEnd; + if(c=='\n' || c=='\0') { + END(); + return; // we're done + } + if(c=='~' || c=='\r' ) { + break; // we found another option + } + pEnd++; + } + + // We have an arg + // Temporarily replace c with '\0' to null-terminate it + // See if it's in the table and set a flag bit if it is + *pEnd='\0'; + for(int i=0; iDataLen; + if(DataLenMAXIMUM_CLIENT_QUERY) { + // Too short or too long, abort +LOG("Abort: Post data length (%d) is too short (less than %d) or too long (more than %d)", +DataLen, MINIMUM_CLIENT_QUERY, MAXIMUM_CLIENT_QUERY); + bAbort=SQ_TRUE; + break; + } + // All POST queries have "nut={12-char nut}" as their query string + if(pSCB->lpszQueryString==NULL) { + // We have a NULL query, abort +LOG("Abort: Query is NULL"); + bAbort=SQ_TRUE; + break; + } + int QueryLen=strlen(pSCB->lpszQueryString); + if(QueryLen < QUERY_STRING_LEN) { + // It's less than 16 characters, abort +LOG("Abort: Query (%s) is less than %d characters", pSCB->lpszQueryString, QUERY_STRING_LEN); + bAbort=SQ_TRUE; + break; + } + SQ_CHAR *pNut=strstr(pSCB->lpszQueryString, pszNutEquals); + if(pNut==NULL) { + // It doesn't contain "nut=", abort +LOG("Abort: Query (%s) doesn't contain 'nut='", pSCB->lpszQueryString); + bAbort=SQ_TRUE; + break; + } + if(strlen(pNut)-strlen(pszNutEquals) < SQRL_NUT_LEN ) { +LOG("Abort: Query (%s) nut length is less than %d", pSCB->lpszQueryString, SQRL_NUT_LEN); + bAbort=SQ_TRUE; + break; + } + pNut+=strlen(pszNutEquals); + + // show that the client's query DOES contain a valid-looking NUT + pParams->DataPresent|=QUERY_NUT; + + // now let's lookup the query's pending authentication by the query NUT + // if it exists we retrieve the object pointer and remove it from the + // queue while we're working on it. If it does not exist we allocate a + // structure to hold our work. Once we're finished we'll re-queue it. + + EnterCriticalSection(&PendingAuthsQueue.CriticalSection); + pPendingAuth=LookupByNut(NULL, pNut, /*UpdateObject*/SQ_FALSE, /*ProtocolNut*/SQ_TRUE, NULL); + + // Set the pointer for our caller's use + *ppPendingAuth=pPendingAuth; + if(pPendingAuth==NULL) { + pParams->DataPresent|=QUERY_NUT_INVALID|QUERY_MAC_INVALID; + } else { + DequeueObject(&PendingAuthsQueue, (QUEUE_OBJECT *)pPendingAuth); + pParams->DataPresent|=PENDING_AUTH_VALID; + } + + LeaveCriticalSection(&PendingAuthsQueue.CriticalSection); + /* + =============================================================================== + We have a query that appears sane, and we found a valid matching query NUT. + Now we parse the the POST's top level arguments of "client=", "server=", + "pids=", 'ids=', 'urs=' + =============================================================================== + */ + // Scan Top Args ("client=", "server=", "ids=", "pids=", "urs=") + //-------------------------------------------------------------- + + // Set pointers to the beginning and end of the POST data + pBeg=pSCB->lpData; +//[ +//. Why does the MASM version skip the first two bytes? +//] + pEnd=pBeg+DataLen; + + // Set a pointer for scanning + pData=pBeg; + + // "client=...&server=..." + // pData: ^ ^ ^ + while(1) { + SQ_CHAR *ptr; + + // Look for the next "=" + if((ptr=memchr(pData, '=', pEnd-pData))==NULL) { + // We have reached the end normally + break; // out of while() + } + // Skip past any "&" + if(*pData=='&') pData++; + + // See which query parameter we have, "client=, "server=" etc. + int i; + for(i=0; iDataPresent&QUERY_CLIENT)==0) {LOG("NULL");} +else {LOG("[]", pData, ValueLen);} +//] + // Allocate memory for the data + pszClient=GlobalAlloc(ValueLen+1); + memcpy(pszClient, pData, ValueLen); + + // Decode it + // The function allocates memory so we need to pass the address of our pointer + DecodeBase64szAndStore((SQ_BYTE **)&pszClientDecode, pszClient); +//[ +LOG("clientDecode:"); +if((pParams->DataPresent&QUERY_CLIENT)==0) {LOG("NULL");} +else {LOG("[]", pszClientDecode, strlen(pszClientDecode));} +//] + break; + + case QUERY_SERVER: +//[ +LOG("server:"); +if((pParams->DataPresent&QUERY_SERVER)==0) LOG("NULL"); +else LOG("[]", pData, ValueLen); +// Allocate memory for the data +pszServer=GlobalAlloc(ValueLen+1); +memcpy(pszServer, pData, ValueLen); +SQ_CHAR *pszServerDecode; +DecodeBase64szAndStore((SQ_BYTE **)&pszServerDecode, pszServer); +LOG("serverDecode:"); +if((pParams->DataPresent&QUERY_SERVER)==0) LOG("NULL"); +else LOG("[]", pszServerDecode, strlen(pszServerDecode)); +GlobalFree((void **)&pszServer); +GlobalFree((void **)&pszServerDecode); +//] + pszServer=GlobalAlloc(ValueLen+1); + memcpy(pszServer, pData, ValueLen); + + // we need to verify that the HMAC of the server's returned value + // equals (one of the) HMACs that we saved when we sent the reply + + HMAC256(aServerMAC, (SQ_BYTE *)pszServer, strlen(pszServer), aSystemKey); + PENDING_AUTHS *pPendingAuth=*ppPendingAuth; + if(pPendingAuth!=NULL) { +//[ +LOG("Check aServerMAC:"); +LOG("[]", aServerMAC, SHA256_BYTE_LEN); +LOG("aTransactionMAC1:"); +LOG("[]", pPendingAuth->aTransactionMAC1, SHA256_BYTE_LEN); +LOG("aTransactionMAC2:"); +LOG("[]", pPendingAuth->aTransactionMAC2, SHA256_BYTE_LEN); +//] + if(memcmp(aServerMAC, pPendingAuth->aTransactionMAC1, BINARY_KEY_LEN)!=0 && + memcmp(aServerMAC, pPendingAuth->aTransactionMAC2, BINARY_KEY_LEN)!=0) { + pParams->DataPresent|=QUERY_MAC_INVALID; + } + } + break; + + case QUERY_IDS: +//[ +LOG(" ids:"); +if((pParams->DataPresent&QUERY_IDS)==0) {LOG("NULL");} +else {LOG("[]", pData, ValueLen);} +//] + if(ValueLen==ASCII_SIG_LEN) { + // Decode it + SqrlCvrtFromBase64(pParams->ids, SIGNATURE_LEN, pData, ValueLen); + } + break; + + case QUERY_PIDS: +//[ +LOG("pids:"); +if((pParams->DataPresent&QUERY_PIDS)==0) {LOG("NULL");} +else {LOG("[]", pData, ValueLen);} +//] + if(ValueLen==ASCII_SIG_LEN) { + // Decode it + SqrlCvrtFromBase64(pParams->pids, SIGNATURE_LEN, pData, ValueLen); + } + break; + + case QUERY_URS: +//[ +LOG(" urs:"); +if((pParams->DataPresent&QUERY_URS)==0) {LOG("NULL");} +else {LOG("[]", pData, ValueLen);} +//] + if(ValueLen==ASCII_SIG_LEN) { + // Decode it + SqrlCvrtFromBase64(pParams->urs, SIGNATURE_LEN, pData, ValueLen); + } + break; + + default: + break; + } + // We found and processed one of "client=", "server=", "ids=" etc. + // Advance the data pointer to the byte after the value we just processed + pData+=ValueLen; + + if(bAbort==SQ_TRUE) { + break; // out of while() + } + // Look for the next top parameter name + } + + if(bAbort==SQ_TRUE) { + break; // out of do() + } + + /* + =============================================================================== + We have parsed the top level client, server, and signature parameters and + converted the various signatures to binary. So now we need to unpack and + parse the client's parameters to obtain the version, commands, and public + keys the client has provided to authenticate its various requests. + =============================================================================== + */ + // ClientParams + //------------- + + // Set pointers to the beginning and end of the client data + if(pszClientDecode==NULL) { +LOG("Abort: No client data"); + bAbort=SQ_TRUE; + break; + } + pBeg=pszClientDecode; +//[ +// Why does the MASM version skip the first two bytes? +//] + DataLen=strlen(pBeg); + pEnd=pBeg+DataLen; + + // Set a pointer for scanning + pData=pBeg; + + // "ver=..\r\ncmd=...\r\n...\r\n\r\n" + //pData: ^ ^ ^ + while(1) { + SQ_CHAR *ptr; + + // Look for the next "=" + if((ptr=memchr(pData, '=', pEnd-pData))==NULL) { + // We have reached the end normally + break; // out of while() + } + // Skip past '\0', CR, LF + if(*pData=='\0') pData++; + if(*pData=='\r') pData++; + if(*pData=='\n') pData++; + + // See which client arg we have, "ver=", "cmd=" etc. + int i; + for(i=0; iSigningBufLen=ClientLen+ServerLen; + pParams->pSigningBuf=(SQ_BYTE *)GlobalAlloc(pParams->SigningBufLen); + + memcpy(pParams->pSigningBuf+0, pszClient, ClientLen); + memcpy(pParams->pSigningBuf+ClientLen, pszServer, ServerLen); + + // we found 'client=', 'server=', 'ids=' & 'idk=' tokens, + // so we can and must verify the provided signature + +//[ +LOG("SigningBuf"); LOG("[]", pParams->pSigningBuf, pParams->SigningBufLen); +LOG("ids"); LOG("[]", pParams->ids, 64); +LOG("idk"); LOG("[]", pParams->idk, 32); +//] + + if(SqrlVerifySig(pParams->pSigningBuf, pParams->SigningBufLen, pParams->ids, pParams->idk)==SQ_PASS) { + // the signature was correct, so let's flag its success + pParams->SignaturesValid|=VALID_IDS; + } + + // if we had a Previous Identity Key and Previous Identity Signature + TestBits=QUERY_PIDK|QUERY_PIDS; + if((pParams->DataPresent&TestBits)==TestBits) { +//[ +LOG("SigningBuf"); LOG("[]", pParams->pSigningBuf, pParams->SigningBufLen); +LOG("pids"); LOG("[]", pParams->pids, 64); +LOG("pidk"); LOG("[]", pParams->pidk, 32); +//] + if(SqrlVerifySig(pParams->pSigningBuf, pParams->SigningBufLen, pParams->pids, pParams->pidk)==SQ_PASS) { + // the signature was correct, so let's flag its success + pParams->SignaturesValid|=VALID_PIDS; + + // we have a previous identity and it was validly signed, + // so we log this identity into our superseded database + SUPERSEDED_IDENTITIES SupersededIdentity; + memcpy(SupersededIdentity.aSupersededIdentity, pParams->pidk, BINARY_KEY_LEN); + LogSupersededID(&SupersededIdentity); + } + } + } while(0); // end of do() + + GlobalFree((void **)&pszClient); + GlobalFree((void **)&pszClientDecode); + GlobalFree((void **)&pszServer); + +LOG("Client to Server Parameters:"); + +LOG(" DataPreset: 0x%08x", pParams->DataPresent); +if((pParams->DataPresent&QUERY_NUT)!=0) LOG(" nut"); +if((pParams->DataPresent&QUERY_CLIENT)!=0) LOG(" client"); +if((pParams->DataPresent&QUERY_SERVER)!=0) LOG(" server"); +if((pParams->DataPresent&QUERY_IDS)!=0) LOG(" ids"); +if((pParams->DataPresent&QUERY_PIDS)!=0) LOG(" pids"); +if((pParams->DataPresent&QUERY_URS)!=0) LOG(" urs"); + +if((pParams->DataPresent&QUERY_NUT_INVALID)==0) LOG(" (nut not invalid)"); else LOG(" nut invalid"); +if((pParams->DataPresent&QUERY_MAC_INVALID)==0) LOG(" (MAC not invalid)"); else LOG(" MAC invalid"); +if((pParams->DataPresent&PENDING_AUTH_VALID)==0) LOG(" (no pending auth)"); else LOG(" pending auth valid"); + +LOG(" Valid Signatures: 0x%08x", pParams->SignaturesValid); +if((pParams->SignaturesValid&VALID_IDS)!=0) LOG(" ids"); +if((pParams->SignaturesValid&VALID_PIDS)!=0) LOG(" pids"); +if((pParams->SignaturesValid&VALID_URS)!=0) LOG(" urs"); + +LOG(" Command(s): 0x%08x", pParams->cmd); +if((pParams->cmd&CMD_QUERY)!=0) LOG(" query"); +if((pParams->cmd&CMD_IDENT)!=0) LOG(" ident"); +if((pParams->cmd&CMD_DISABLE)!=0) LOG(" disable"); +if((pParams->cmd&CMD_ENABLE)!=0) LOG(" enable"); +if((pParams->cmd&CMD_REMOVE)!=0) LOG(" remove"); + +LOG(" Options: 0x%08x", pParams->opt); +if((pParams->opt&OPT_SQRLONLY)!=0) LOG(" sqrlonly"); +if((pParams->opt&OPT_HARDLOCK)!=0) LOG(" hardlock"); +if((pParams->opt&OPT_CPS_MODE)!=0) LOG(" cps"); +if((pParams->opt&OPT_SUK_REQ)!=0) LOG(" suk"); +if((pParams->opt&OPT_NOIPTEST)!=0) LOG(" noiptest"); + + END(); + return (bAbort==SQ_FALSE? SQ_PASS: SQ_FAIL); +} + +/* +-------------------------------------------------------------------------- + SanityCheckAsciiKey + this scans a CR/LF/null-terminated string, + null terminates it, and checks its length. +-------------------------------------------------------------------------- +*/ +SQ_RCODE SanityCheckAsciiKey(SQ_CHAR *pKey) { + SQ_CHAR *pEnd=NullTerminateString(pKey); + return (pEnd-pKey==ASCII_KEY_LEN? SQ_PASS: SQ_FAIL); +} +/* +-------------------------------------------------------------------------- + NullTerminateString + we're standing at the start of a run of characters + so we scan forward to the first CR, LF, '&' or NULL + and convert THAT character to a null for term, +-------------------------------------------------------------------------- +*/ +SQ_CHAR *NullTerminateString(SQ_CHAR *ptr) { + while(*ptr!='\0') { + if(*ptr=='\r' || *ptr=='\n') { + *ptr='\0'; + break; + } + ptr++; + } + return ptr; +} + +/* +=============================================================================== + HANDLE CLIENT QUERY +------------------------------------------------------------------------------- +*/ +SQ_RCODE HandleClientQuery(SQRL_CONTROL_BLOCK *pSCB) { + BEG("HandleClientQuery()"); + SQ_RCODE rc=SQ_FAIL; + SQ_DWORD TransInfo; + CLIENT_TO_SERVER QueryParams; + PENDING_AUTHS *pPendingAuth; + SQ_BYTE aIPaddress[16]; + SQRL_ASSOCIATIONS SqrlAssoc; + SQRL_ASSOCIATIONS *pSqrlAssoc=&SqrlAssoc; + ASSOC_REC_DATA *pAssocRecData=&SqrlAssoc.AssocRecData; + SQ_DWORD TestBits; + + TransInfo=0; + + // the subsequent call to "ParseClientQuery" looks up and populates the + // PendingAuth structure from our previous browser queries which created + // and setup the various structure components. We use the szInvitation, + // szSqrlPublicKey and TransactionMAC fields during this work below... + + if(ParseClientQuery(&QueryParams, &pPendingAuth, pSCB)==SQ_FAIL) { + rc=SendSqrlReply(pSCB, NULL, 0, SQ_FAIL); + END(); + return rc; + } + // Bit set indicates an error + if((QueryParams.DataPresent&QUERY_NUT_INVALID)==QUERY_NUT_INVALID) { + TransInfo|=(COMMAND_FAILED|TRANSIENT_ERROR); +//[ +LOG("Query Nut Invalid -> TIF=0x%x", TransInfo); +//] + } + + // Bit set indicates an error + if((QueryParams.DataPresent&QUERY_MAC_INVALID)==QUERY_MAC_INVALID) { + TransInfo|=(COMMAND_FAILED|CLIENT_FAILED); +//[ +LOG("Query MAC Invalid -> TIF=0x%x", TransInfo); +//] + } + + // Bits not set indicate an error (all TestBits must be set) + TestBits=QUERY_NUT|QUERY_CLIENT|QUERY_SERVER|QUERY_IDS|QUERY_IDK|QUERY_VER|QUERY_CMD; + if((QueryParams.DataPresent&TestBits) != TestBits) { + TransInfo|=(COMMAND_FAILED|CLIENT_FAILED); +//[ +LOG("Query Nut %s", (TestBits&QUERY_NUT)==0? "Missing": "OK"); +LOG("Query Client %s", (TestBits&QUERY_CLIENT)==0? "Missing": "OK"); +LOG("Query Server %s", (TestBits&QUERY_SERVER)==0? "Missing": "OK"); +LOG("Query IDS %s", (TestBits&QUERY_IDS)==0? "Missing": "OK"); +LOG("Query IDK %s", (TestBits&QUERY_IDK)==0? "Missing": "OK"); +LOG("Query Ver %s", (TestBits&QUERY_VER)==0? "Missing": "OK"); +LOG("Query Cmd %s", (TestBits&QUERY_CMD)==0? "Missing": "OK"); +LOG(" -> TIF=0x%x", TransInfo); +//] + } + + // if we did locate the pending auth object NUT, we check the IP + if((QueryParams.DataPresent&PENDING_AUTH_VALID)==PENDING_AUTH_VALID) { + // check to see whether we have an IP match + ObtainClientConnectionIP(aIPaddress, pSCB); + + if(memcmp(aIPaddress, pPendingAuth->aRequestIP, sizeof(aIPaddress))!=0) { + if((QueryParams.opt&OPT_NOIPTEST)==0) { + TransInfo|=(COMMAND_FAILED); +//[ +LOG("IP Address Mismatch and opt=noiptest -> TIF=0x%x", TransInfo); +//] +//[ +LOG("aIPaddress: (dec):"); +LOG("[d]", aIPaddress, IPV6_BYTE_LEN); +LOG("pPendingAuth->aRequestIP: (dec):"); +LOG("[d]", pPendingAuth->aRequestIP, IPV6_BYTE_LEN); +//] + } + } + else { + TransInfo|=IP_ADDRESS_MATCH; +//[ +LOG("IP Address Match -> TIF=0x%x", TransInfo); +//] + } + } + // if we have already determined that things are not right, we fail fast + if((TransInfo&COMMAND_FAILED)==COMMAND_FAILED) { + rc=SendResponse(pSCB, &QueryParams, TransInfo, pSqrlAssoc, pPendingAuth); + END(); + return rc; + } + + /* + ------------------------------------------------------------------------------- + We have parsed the client's query and have set the collection of bit flags + based upon the presence of client keys and signatures. Now we use what we + know to load up the associated SQRL record, if any. If we cannot locate a + record by SQRL ID, we'll check to see whether we have a pending invitation + and can locate a record by this invitation. + ------------------------------------------------------------------------------- + */ + memset(pSqrlAssoc, 0, sizeof(SQRL_ASSOCIATIONS)); + + // if we have a valid =CURRENT= ID signature... see if we know them + if((QueryParams.SignaturesValid&VALID_IDS)==VALID_IDS) { + // before we check for them using their cursor key, + // we check to see whether they are presenting a key + // that's known to have been previously superseded + SUPERSEDED_IDENTITIES SupersededIdentity; + memcpy(SupersededIdentity.aSupersededIdentity, QueryParams.idk, BINARY_KEY_LEN); +///[ +//Alternate implementation to allow non-query commands to proceed +/* + + if(CheckForSupersededID(&SupersededIdentity)==SQ_PASS) { + TransInfo|=SUPERSEDED_ID; + if(QueryParams.cmd!=CMD_QUERY) { + TransInfo|=COMMAND_FAILED; + } + rc=SendResponse(pSCB, &QueryParams, TransInfo, pSqrlAssoc, pPendingAuth); + END(); + return rc; + } +*/ + if(CheckForSupersededID(&SupersededIdentity)==SQ_PASS) { + TransInfo|=SUPERSEDED_ID; + } +///] + if(GetRecordBySqrlKey(pSqrlAssoc, QueryParams.idk)==SQ_PASS) { + // a record WAS found for this user under their CURRENT + // Identity Key, so let's note that success + TransInfo|=CURRENT_ID_MATCH; + + // and we have retrieved the record so we can get the + // identity's SUK value in case we need to offer it + } + } + + // if we have a valid =PREVIOUS= ID signature... see if we know them + if((QueryParams.SignaturesValid&VALID_PIDS)==VALID_PIDS) { + if(GetRecordBySqrlKey(pSqrlAssoc, QueryParams.pidk)==SQ_PASS) { + // a record WAS found for this user under their PREVIOUS + // Identity Key, so let's note that success + TransInfo|=PREVIOUS_ID_MATCH; + + // set the USER_REKEYED flag to notify the web server + // in case it wants to do something with the information + pAssocRecData->SqrlOptionFlags|=USER_REKEYED; + StoreSqrlRecord(pSqrlAssoc); + + // and we have retrieved the record so we can get the + // identity's SUK value in case we need to offer it + } + } + + // if SQRL login is flagged as disabled in the user's record + // we need to set the TIF flag now so that the QUERY op reports + if((pAssocRecData->SqrlOptionFlags&AUTH_DISABLED)==AUTH_DISABLED) { + TransInfo|=SQRL_DISABLED; + } + + // is this an initial 'query' query + if(QueryParams.cmd==CMD_QUERY) { +//[ +// We already exited above if there was a command failure and have not set +// the bit since, so the follow code from the original MASM is not needed. +//] +/* + // if so, we won't label this as a command failure + // UNLESS we also had a client failure + if((TransInfo&CLIENT_FAILED)==0) { + TransInfo&=~COMMAND_FAILED; + } +*/ + rc=SendResponse(pSCB, &QueryParams, TransInfo, pSqrlAssoc, pPendingAuth); + END(); + return rc; + } + + if((TransInfo&COMMAND_FAILED)==COMMAND_FAILED) { + rc=SendResponse(pSCB, &QueryParams, TransInfo, pSqrlAssoc, pPendingAuth); + END(); + return rc; + } + + /* + ========================[ END OF CMD_QUERY PROCESSING ]======================== + */ + // if we did find the user, we will have loaded their Sqrl data from the + // SQRL association database. So now we can verify their URS signature + // if they provided one... + + TestBits=(CURRENT_ID_MATCH|PREVIOUS_ID_MATCH); + if((TransInfo&TestBits)!=0 && (QueryParams.DataPresent&QUERY_URS)==QUERY_URS && QueryParams.SigningBufLen!=0) { + if(SqrlVerifySig(QueryParams.pSigningBuf, QueryParams.SigningBufLen, QueryParams.urs, pAssocRecData->aSqrlVerifyUnlockKey)==SQ_PASS) { + // the signature was correct, so let's flag its success + QueryParams.SignaturesValid|=VALID_URS; + } +//[ +else { + LOG("URS Verification failed"); +} +//] + } + + /* + ------------------------------------------------------------------------------- + ==========================[ BEGIN ACTIVE PROCESSING ]========================== + ------------------------------------------------------------------------------- + */ + // If this query contains everything we need to update the user's account + // from their previous identity, we do so now... + if((TransInfo&PREVIOUS_ID_MATCH)==PREVIOUS_ID_MATCH && (QueryParams.SignaturesValid&VALID_URS)==VALID_URS) { + // we're updating our identity key so we always re-enable access + pAssocRecData->SqrlOptionFlags&=~AUTH_DISABLED; + + // re-store the record under the newly updated SQRL identity... + UpdateSqrlAssociationRecord(&SqrlAssoc, &QueryParams); + + // now we turn OFF "previous match" and turn on "current match" + TransInfo&=~PREVIOUS_ID_MATCH; + TransInfo|=CURRENT_ID_MATCH; +//[ +LOG("Previous IDK Rekeyed to Current IDK -> TIF=0x%x", TransInfo); +//] + } + + // if the user was not identified by current or previous ID, + // we cannot perform any database updates or commands, so we + // need to check to see whether we're being asked to do an + // ENABLE, DISABLE or REMOVE, which requires recognition: + + TestBits=CMD_DISABLE|CMD_ENABLE|CMD_REMOVE; + if((TransInfo&(CURRENT_ID_MATCH|PREVIOUS_ID_MATCH))==0 && (QueryParams.cmd&TestBits)!=0) { + TransInfo|=COMMAND_FAILED; +//[ +LOG("No ID match with Disable, Enable, or Remove command -> TIF=0x%x", TransInfo); +//] + rc=SendResponse(pSCB, &QueryParams, TransInfo, pSqrlAssoc, pPendingAuth); + END(); + return rc; + } + + // we have the possibly-updated SQRL identity (IDK) from the authenticated + // SQRL transaction, so let's move the client's IDK into our Pending Auths + CvrtToBase64String(pPendingAuth->szSqrlPublicKey, ASCII_KEY_LEN, QueryParams.idk, BINARY_KEY_LEN); + + // we'll also capture the non-Query transaction's "opt" value so that it + // can later be sent to the webserver as the 'status' so that SqrlOnly + // and HardLock can be maintained for the account's owner + pPendingAuth->OptionsValue=QueryParams.opt; + + /* + ======================[ HANDLE SPECIFIC CLIENT COMMANDS ]====================== + */ + switch(QueryParams.cmd) { + case CMD_IDENT: + // if the account is disabled, we fail the IDENT command + if((TransInfo&SQRL_DISABLED)==SQRL_DISABLED) { + TransInfo|=COMMAND_FAILED; +//[ +LOG("cmd=ident SQRL Disabled -> TIF=0x%x", TransInfo); +//] + break; + } + if((TransInfo&(CURRENT_ID_MATCH|PREVIOUS_ID_MATCH))==0) { + // if we're being asked to associate a possibly new ID, + // has the client provided all of the material we'll need? + SQ_DWORD TestBits; + TestBits=QUERY_IDK|QUERY_SUK|QUERY_VUK; + if((QueryParams.DataPresent&TestBits)!=TestBits) { + TransInfo|=COMMAND_FAILED; +//[ +LOG("cmd=ident, new id, IDK/SUK/VUK missing -> TIF=0x%x", TransInfo); +//] + break; + } + + // we have not found a record by our current or previous + // SQRL identity. So let's see whether we have a pending + // invitation for this new and successful authentication + if((QueryParams.DataPresent&PENDING_AUTH_VALID)==PENDING_AUTH_VALID &&(strlen(pPendingAuth->szInvitation)!=0)) { + // look for a pending invitation + GetRecordByInvitation(pSqrlAssoc, pPendingAuth->szInvitation); + } + + // we did not already have a SQRL association record. so + // we create one, either to accept an invitation, in which + // case the Account will already be filled-in and we'll + // have a completed association, or with the Account not + // yet filled so we'll have a pending association. + UpdateSqrlAssociationRecord(&SqrlAssoc, &QueryParams); + } + + // if we are NOT using CPS mode, we won't be authenticating when + // the client issues the /cps.sqrl? query. So we notify the web + // server NOW since we have a successful IDENT authentication... + if((QueryParams.opt&OPT_CPS_MODE)==0 && (TransInfo & COMMAND_FAILED)==0) { + TriggerNonCpsAuth(pPendingAuth, pSCB); + } + break; + + case CMD_DISABLE: + // set the account disabled bit + pAssocRecData->SqrlOptionFlags|=AUTH_DISABLED; + StoreSqrlRecord(pSqrlAssoc); + TransInfo|=SQRL_DISABLED; +//[ +LOG("cmd=disable -> TIF=0x%x", TransInfo); +//] + break; + + case CMD_ENABLE: + if((QueryParams.SignaturesValid&VALID_URS)==VALID_URS) { + // we're enabling a disabled account, so we turn off + // the SQRL-disabled bit and save the result + pAssocRecData->SqrlOptionFlags&=~AUTH_DISABLED; + StoreSqrlRecord(pSqrlAssoc); + TransInfo&=~SQRL_DISABLED; +//[ +LOG("cmd=enable, Valid URS -> TIF=0x%x", TransInfo); +//] + } + else { + TransInfo|=COMMAND_FAILED; +//[ +LOG("cmd=enable, Invalid URS -> TIF=0x%x", TransInfo); +//] + } + break; + + case CMD_REMOVE: + if((QueryParams.SignaturesValid&VALID_URS)==VALID_URS) { + // we're removing a SQRL identity and account association + pAssocRecData->SqrlOptionFlags|=REMOVE_REQUESTED; + StoreSqrlRecord(pSqrlAssoc); +//[ +LOG("cmd=remove, Valid URS -> TIF=0x%x", TransInfo); +//] + } + else { + TransInfo|=COMMAND_FAILED; +//[ +LOG("cmd=remove, Invalid URS -> TIF=0x%x", TransInfo); +//] + } + break; + + default: +//[ +// I added this +//] + // Indicate failure and clear other status bits) + TransInfo=(COMMAND_FAILED|CLIENT_FAILED|CMD_NOT_SUPPORTED); +//[ +LOG("cmd=??? -> TIF=0x%x", TransInfo); +//] + break; + } + + rc=SendResponse(pSCB, &QueryParams, TransInfo, pSqrlAssoc, pPendingAuth); + END(); + return rc; +} + +SQ_BOOL IsNonZero(SQ_BYTE *pBuffer, SQ_DWORD BufLen) { + int i; + for(i=0; iAssocRecData; + SQ_CHAR szTheNextNut[16]; + + // release any existing allocated signing buffer + GlobalFree((void **)&pQueryParams->pSigningBuf); + + // first we'll create a 2K ReplyBuffer for our normal needs. + SQ_CHAR *pszReplyBuffer=(SQ_CHAR *)GlobalAlloc(2048); + + // place a 12-character zero-terminated string into "szNextNut" + GetUnique12charNut(szTheNextNut, /*Null-Terminate=*/SQ_TRUE); + + // we grab this pending auth's path extension string, if any + char *pPathExt=(char *)pszNull; + if(pPendingAuth!=NULL) { + pPathExt=pPendingAuth->szPathExtension; + } + + // place out the beginning of the reply with 'nut', 'TIF', 'nut' + sprintf(pszReplyBuffer, pszSqrlReplyFormat, szTheNextNut, TransInfo, pPathExt, szTheNextNut); + + // if the original query nut was invalid, it's not going to get any better + // so we only add to the response if the nut is not invalid + + if((pQueryParams->DataPresent&QUERY_NUT_INVALID)==0) { + // Now we conditionally append the SUK data ONLY IF we have it, and if + // the client either might need it OR has explicitly asked for it. The + // client might need it if our previous ID matched, or our current ID + // matched *and* the account is disabled + + SQ_BOOL bHaveSUK = IsNonZero(pAssocRecData->aSqrlServerUnlockKey, BYTES_FOR_256_BITS); + SQ_BOOL bClientAsks = (pQueryParams->opt&OPT_SUK_REQ)==OPT_SUK_REQ; + SQ_BOOL bPreviousMatch = (TransInfo&PREVIOUS_ID_MATCH)==PREVIOUS_ID_MATCH; + SQ_BOOL bCurrentMatch = (TransInfo&CURRENT_ID_MATCH)==CURRENT_ID_MATCH; + SQ_BOOL bAcctDisabled = (TransInfo&SQRL_DISABLED)==SQRL_DISABLED; + + if(bHaveSUK && (bClientAsks || bPreviousMatch || (bCurrentMatch && bAcctDisabled))) { + strcat(pszReplyBuffer, "suk="); + + // convert the identity's SUK to Base64url ASCII + SqrlCvrtToBase64(pszReplyBuffer+strlen(pszReplyBuffer), ASCII_KEY_LEN, + pAssocRecData->aSqrlServerUnlockKey, BINARY_KEY_LEN); + + strcat(pszReplyBuffer, "\r\n"); + } + // if we are using Client Provided Session (CPS) and we have the CPS URL + if(pQueryParams->cmd!=CMD_QUERY && (pQueryParams->opt&OPT_CPS_MODE)==OPT_CPS_MODE) { + // append 'url=https://{hostname}/cps.sqrl?{CPS token} + strcat(pszReplyBuffer, pszUrlPrefix); + PlaceCpsUrlIntoBuffer(pszReplyBuffer+strlen(pszReplyBuffer), pPendingAuth); + strcat(pszReplyBuffer, "\r\n"); + } + } +//[ + LOG("pszReplyBuffer:"); + LOG("[]", pszReplyBuffer, strlen(pszReplyBuffer)); +//] + + // now we base64url convert the assembled reply data...Send: + SQ_DWORD BufLen=strlen((SQ_CHAR *)pszReplyBuffer); + SQ_DWORD BufSiz=GetBase64urlEncodedSize(BufLen)+1; + SQ_BYTE *pEncReplyBuffer=(SQ_BYTE *)GlobalAlloc(BufSiz); + + BufLen=SqrlCvrtToBase64((SQ_CHAR *)pEncReplyBuffer, BufSiz, (SQ_BYTE *)pszReplyBuffer, BufLen); + + if(pPendingAuth!=NULL) { + // now calculate our reply's HMAC256 and update the PendingAuth list + // the length of pEncReplyBuffer (BufLen) was returned by SqrlCvrtToBase64 + + HMAC256(pPendingAuth->aTransactionMAC1, pEncReplyBuffer, BufLen, aSystemKey); + memset(pPendingAuth->aTransactionMAC2, 0, SHA256_BYTE_LEN); + +LOG("Calculation of HMAC1 in SendResponse():"); +LOG("Encoded Reply:"); +LOG("[c]", pEncReplyBuffer, BufLen); +LOG("TransactionMAC1:"); +LOG("[]", pPendingAuth->aTransactionMAC1, SHA256_BYTE_LEN); + + // now we copy the new nut into our pending auths structure + memcpy(pPendingAuth->aProtocolNut, szTheNextNut, SQRL_NUT_LEN); + + // and we return this object to the pending auths queue for subsequent use + Enqueue(&PendingAuthsQueue, (QUEUE_OBJECT *)pPendingAuth); + } + rc=SendSqrlReply(pSCB, pEncReplyBuffer, BufLen, SQ_PASS); + + GlobalFree((void **)&pszReplyBuffer); + GlobalFree((void **)&pEncReplyBuffer); + END(); + return rc; +} + +/* +=============================================================================== + UpdateSqrlAssociationRecord: +------------------------------------------------------------------------------- +*/ +void UpdateSqrlAssociationRecord(SQRL_ASSOCIATIONS *pSqrlAssoc, CLIENT_TO_SERVER *pQueryParams) { + ASSOC_REC_DATA *pAssocRecData=&pSqrlAssoc->AssocRecData; + + // update the SQRL identity keys from the client's provided data + memcpy(pAssocRecData->aSqrlServerUnlockKey, pQueryParams->suk, BINARY_KEY_LEN); + memcpy(pAssocRecData->aSqrlVerifyUnlockKey, pQueryParams->vuk, BINARY_KEY_LEN); + memcpy(pAssocRecData->aSqrlPublicIdentity, pQueryParams->idk, BINARY_KEY_LEN); + + // save the new record under its new key... + StoreSqrlRecord(pSqrlAssoc); +} + diff --git a/SSP-API-Source/configdata.c b/SSP-API-Source/configdata.c new file mode 100644 index 0000000..4d88ead --- /dev/null +++ b/SSP-API-Source/configdata.c @@ -0,0 +1,519 @@ + +// configdata.c + +#include "global.h" + +static const char *pTheOpenFilename=NULL; + +int HexToNybble(int h) { + // quick conversion for valid hex characters 0-9, A-F, a-f + // also 'converts' non-hex characters (which shouldn't be there anyway) + if(h>0x3f) h+=9; + return h&0x0f; +} +int NybbleToHex(int n) { + // quick conversion for numbers 0-15 to '0'-'9', 'A'-'F' + // also 'converts' larger numbers (which shouldn't be there anyway) + n&=0x0f; // must be 0-15 + return n<=9? '0'+n: 'A'+n-10; +} + +SQ_RCODE CreateFile(FILE **ppFile, const char *pFilename, char *pMode) { + // this is only called by OpenFile() + *ppFile=fopen(pFilename, "w"); + if(*ppFile==NULL) { + LOG("Unable to create file %s", pFilename); + return SQ_FAIL; + } + fclose(*ppFile); + + // re-open the file as requested + *ppFile=fopen(pFilename, pMode); + if(*ppFile==NULL) { + LOG("Unable to create file %s", pFilename); + return SQ_FAIL; + } + // pFile is valid + return SQ_PASS; +} + +SQ_RCODE OpenFile(FILE **ppFile, const char *pFilename, char *pMode) { + // open the file for reading and writing (binary if applicable) + pTheOpenFilename=(char *)pFilename; + *ppFile=fopen(pFilename, pMode); + if(*ppFile==NULL) { + // if the file doesn't exit create it + if(CreateFile(ppFile, pFilename, pMode)==SQ_FAIL){ + *ppFile=NULL; + return SQ_FAIL; + } + } + // pFile is valid + return SQ_PASS; +} + +SQ_RCODE CloseFile(FILE **ppFile) { + SQ_RCODE rc=SQ_PASS; + + if(*ppFile!=NULL) { + rc|=fflush(*ppFile); + rc|=fclose(*ppFile); + *ppFile=NULL; + } + if(rc!=SQ_PASS) { + LOG("Error closing file %s", pTheOpenFilename); + rc=SQ_FAIL; + } + pTheOpenFilename=NULL; + return rc; +} + +/*************** +READ CONFIG FILE +***************/ + +SQ_RCODE ReadCfgFile(CFG_ITEM **ppCfgItems, char **ppData) { + BEG("ReadCfgFile()"); + // Note: The caller supplies pointer for pCfgItems and pData + // This function allocates memory of them + // The caller must free that memory. + + SQ_RCODE rc=SQ_PASS; + FILE *pFile; + + if(OpenFile(&pFile, pszCfgFile, "rb")==SQ_FAIL) { + END(); + return SQ_FAIL; + } + + // Set up the name=value table + *ppCfgItems=(CFG_ITEM *)GlobalAlloc(CFG_NUM_ITEMS*sizeof(CFG_ITEM)); + CFG_ITEM *pCfgItems=*ppCfgItems; + + int i; + for(i=0; i>4); + pszBuffer[j+1]=(char)NybbleToHex(n&0x0f); + } + fclose(pRandomDev); + + // Null-terminate it + pszBuffer[i*2]='\0'; + return SQ_PASS; +} + +SQ_CHAR szMonotonicCounter[BYTES_FOR_64_BITS*2+1]; + +const SQ_CHAR szHandlerName[HANDLER_NAME_SIZ]; +const SQ_CHAR szCertFilename[SQ_MAX_PATH]; +const SQ_CHAR szKeyFilename[SQ_MAX_PATH]; +const SQ_CHAR szListenIp[SQ_IP_LEN+1]; +const SQ_CHAR szListenPort[SQ_PORT_LEN+1]; +const SQ_CHAR szPrivateAccessIp[SQ_IP_LEN+1]; +const SQ_CHAR szSystemKey[BYTES_FOR_256_BITS*2+1]; +const SQ_CHAR szDatabaseKey[DATABASE_KEY_LEN+1]; +const SQ_CHAR szTransactionLogging[sizeof(char)+1]; +const SQ_CHAR szPublicAuthDomain[SQ_MAX_URL]; +const SQ_CHAR szWebServerAuthUrlArray[10][SQ_MAX_URL]; + +const SQ_HANDLER nHandlerName; +const SQ_CHAR szListenUrl[8+SQ_IP_LEN+1+SQ_PORT_LEN+1]; // https://: +const SQ_BOOL bEnableTransactionLogging; + +int ReadLine(char *pszBuffer, int BufLen) { + // BufLen is the maximum string length + // The buffer size is BufLen+1 + int n=0; + while(1) { + // Input characters until CR + char c=getchar(); + if(c=='\r' || c=='\n') break; + if(n>4); + aHex[k+1]=(char)NybbleToHex(pCounterByteArray[j]&0x0f); + } + // Null-terminate and save + aHex[BYTES_FOR_64_BITS*2]='\0'; + rc=SetCfgItem(CFG_MONOTONIC_COUNTER, aHex); + + return rc; +} +SQ_RCODE SetCfgItem(int ItemIndex, char *pszItemValue) { + BEG("SetCfgItem()"); + SQ_RCODE rc=SQ_PASS; + int i=ItemIndex; + + CFG_ITEM *pCfgItems; + char *pData; + ReadCfgFile(&pCfgItems, &pData); + pCfgItems[ItemIndex].pszValue=pszItemValue; + strncpy((char *)aCfgInfo[i].pszVariable, pCfgItems[i].pszValue, aCfgInfo[i].Length); + rc=WriteCfgFile(pCfgItems, pData); + GlobalFree((void **)&pCfgItems); + GlobalFree((void **)&pData); + + END(); + return rc; +} diff --git a/SSP-API-Source/criticalsection.c b/SSP-API-Source/criticalsection.c new file mode 100644 index 0000000..4417837 --- /dev/null +++ b/SSP-API-Source/criticalsection.c @@ -0,0 +1,87 @@ + +// criticalsection.c + +#include "global.h" + +CRITICAL_SECTION DebugCriticalSection; +CRITICAL_SECTION IncDataCriticalSection; + +int InitializeCriticalSection(CRITICAL_SECTION *pLock) { + BEG("InitializeCriticalSection()"); + LOG("pLock: %p", pLock); + + pLock->count=0; + int rc=pthread_mutex_init(&pLock->Lock, NULL); + if(rc!=0) { + // ERROR: Cannot create mutex + perror("Cannot create mutex\r\n"); + } + END(); + return rc; +} + +int DeleteCriticalSection(CRITICAL_SECTION *pLock){ + BEG("DeleteCriticalSection()"); + LOG("pLock: %p", pLock); + + pLock->count=0; + int rc=pthread_mutex_destroy(&pLock->Lock); + if(rc!=0) { + perror("Cannot destroy mutex\r\n"); + } + END(); + return rc; +} + +SQ_BOOL EnterCriticalSection(CRITICAL_SECTION *pLock) { + BEG("EnterCriticalSection()"); + LOG("pLock: %p", pLock); + LOG("Count: %d", pLock->count); + + pLock->count++; + if(pLock->count > 1) { + END(); + return SQ_FALSE; + } + + if(StackNdx>1) { + // Log the locking function + LOG("%s (Ndx %d)", pStack[StackNdx-2], StackNdx); + } + + /* Enter the critical section -- other threads are locked out */ + int rc=0; + rc=pthread_mutex_lock(&pLock->Lock); + if(rc!=0) { + perror("Cannot lock mutex\r\n"); + } + + END(); + return SQ_TRUE; +} + +SQ_BOOL LeaveCriticalSection(CRITICAL_SECTION *pLock) { + BEG("LeaveCriticalSection()"); + LOG("pLock: %p", pLock); + LOG("Count: %d", pLock->count); + + pLock->count--; + if(pLock->count > 0) { + END(); + return SQ_FALSE; + } + + if(StackNdx>1) { + // Log the unlocking function + LOG("%s (Ndx %d)", pStack[StackNdx-2], StackNdx); + } + + /* Leave the critical section -- other threads can now pthread_mutex_lock() */ + int rc=pthread_mutex_unlock(&pLock->Lock); + if(rc!=0) { + perror("Cannot unlock mutex\r\n"); + } + + END(); + return SQ_TRUE; +} \ No newline at end of file diff --git a/SSP-API-Source/crypto.c b/SSP-API-Source/crypto.c new file mode 100644 index 0000000..3f9762b --- /dev/null +++ b/SSP-API-Source/crypto.c @@ -0,0 +1,105 @@ + +// crypto.c + +#include "global.h" +#include "sodium.h" + +/* +============================================================================ + HMAC256 + -------------------------------------------------------------------------- + BYTES_FOR_256_BITS (16 byte long key) + in: pSourceToHMAC + in: Len + in: pHashKey + out: pHastOut +---------------------------------------------------------------------------- +*/ +SQ_RCODE HMAC256(SQ_BYTE *pHashOut, SQ_BYTE *pSourceToHMAC, SQ_DWORD Len, const SQ_BYTE *pHashKey) { + BEG("HMAC256()"); + LOG("in:"); + LOG("[]", pSourceToHMAC, Len); + + SQ_QWORD SourceLen; + SourceLen=(SQ_QWORD)Len; + + int rc=crypto_auth_hmacsha256(pHashOut, pSourceToHMAC, SourceLen, pHashKey); + + LOG("out"); + LOG("[]", pHashOut, SHA256_BYTE_LEN); + END(); + return (rc==0? SQ_PASS: SQ_FAIL); +} + +/* +============================================================================ + SQRL VERIFY SIG + -------------------------------------------------------------------------- + What: Given a message that was previously signed, the signature that was + previously obtained, and the public key matching the private key + that was originally used, this returns 0 for successful signature + verification or -1 in the event of anything amiss. + + How: The Sodium library wants to see a composite "sig | message" buffer, + but SQRL uses separate signatures. So we need to rebuild a hybrid + buffer to pass to Sodium. Sodium also wants to return a result + msg buffer which we don't want. But it also uses it as a working + scratch buffer. So we need to supply it a scratch buffer too. + + Args: (in) ptr to (unsigned) message to check + (in) len of message to check + (in) ptr to 64-byte signature + (in) ptr to 32-byte public key + + Retr: 0 == Success + 0 != Failure / HeapAlloc or Signature Verify failure +---------------------------------------------------------------------------- +*/ +SQ_RCODE SqrlVerifySig(SQ_BYTE *pMsg, SQ_DWORD uMsgLen, SQ_BYTE *pSig, SQ_BYTE *pPubKey) { + BEG("SqrlVerifySig"); + SQ_QWORD smlen; + SQ_QWORD mlen; + + // the signed message length is 64 bytes longer than the caller's + // provided message length. So we adjust the length up by 64 bytes... + + smlen=mlen=(SQ_QWORD)(uMsgLen+crypto_sign_BYTES); + + // create a temporary source buffer into which we will assemble + // a composite signed message of the sort Sodium wants to see + + SQ_BYTE *pSrcBuf; + pSrcBuf=(SQ_BYTE *)GlobalAlloc(smlen); + + // annoyingly, Sodium uses the "return" buffer (which we neither + // need nor want) as scratch space while working. So we need to + // give it a same-size working buffer to mess around with + + SQ_BYTE *pRetBuf; + pRetBuf=(SQ_BYTE *)GlobalAlloc(mlen); + + // copy the signature into the first 64 bytes of the source buffer + memcpy(pSrcBuf, pSig, crypto_sign_BYTES); + + // copy the caller's message to be sig-checked into the buffer balance + memcpy(pSrcBuf+crypto_sign_BYTES, pMsg, uMsgLen); + + // we're now setup to invoke Sodium's signature verification + // function it writes into and mucks around with the 'edi' + // scratch buffer and the mlen length + + assert(sizeof(SQ_QWORD)==sizeof(long long unsigned int)); + long long unsigned int *pmlen=(long long unsigned int *)&mlen; + int rc=crypto_sign_open(pRetBuf, pmlen, pSrcBuf, smlen, pPubKey); + + // one way or another we're all done now, so we free up our allocs + GlobalFree((void **)&pSrcBuf); + GlobalFree((void **)&pRetBuf); + +//[ +if(rc==SQ_PASS) LOG("Verification Passed"); else LOG("Verification Failed"); +//] + + END(); + return (rc==0? SQ_PASS: SQ_FAIL); +} diff --git a/SSP-API-Source/database.c b/SSP-API-Source/database.c new file mode 100644 index 0000000..de8ebbb --- /dev/null +++ b/SSP-API-Source/database.c @@ -0,0 +1,1247 @@ + +// database.c - Interface ot the Berkeley Database + +#include "global.h" +#include "db.h" + +pthread_t DBSweepThreadId; + +const SQ_CHAR *pszMainDBname="sqrl-assoc.db"; // Primary account database file +const SQ_CHAR *pszAcctDBname="sqrl-index.db"; // Secondary Accounts index +const SQ_CHAR *pszSqrlDBname="sqrl-ident.db"; // Secondary SQRL identity index +const SQ_CHAR *pszDeadDBname="sqrl-super.db"; // Superseded identities log file + +DB *pMainDB; +DB *pAcctDB; +DB *pSqrlDB; +DB *pDeadDB; +/* +=============================================================================== + OPEN BDB +------------------------------------------------------------------------------- + Create an instance of a DB structure (called BDB here since 'db' is a + MASM reserved name), set a 4K page size, 32K caching size, specify and + enable AES encryption, and open the indicated file, returning the status. +------------------------------------------------------------------------------- +*/ +DB *OpenBDB(const SQ_CHAR *pszDBname, SQ_BOOL AllowDups) { + BEG("OpenBDB()"); + SQ_CHAR szDatabaseFile[SQ_MAX_PATH]; + DB *ptrBDB; + + GetDatabasePathname(szDatabaseFile); + strcat(szDatabaseFile, pszDBname); + + db_create((DB **)&ptrBDB, NULL, 0); + + // set the database's page size to 4K (NTFS's cluster size) + ptrBDB->set_pagesize(ptrBDB, 4096); + + // set the database's cache size to 32K (system enforced min is 20K) + ptrBDB->set_cachesize(ptrBDB, 0, 32768, 1); + + // set the database's encryption mode (AES) and password key + ptrBDB->set_encrypt(ptrBDB, szDatabaseKey, DB_ENCRYPT_AES); + + // specify that we will be using checksum and encryption + SQ_DWORD flags=DB_CHKSUM|DB_ENCRYPT; + if(AllowDups==SQ_TRUE) { + flags|=DB_DUP|DB_DUPSORT; + } + ptrBDB->set_flags(ptrBDB, flags); + + // and now open the database + if(ptrBDB->open(ptrBDB, NULL, szDatabaseFile, NULL, DB_BTREE, DB_CREATE|DB_THREAD, 0)!=0) { + ptrBDB=NULL; + } + + END(); + return ptrBDB; +} + +/* +=============================================================================== + SAFE DATABASE CLOSE +=============================================================================== +*/ +SQ_RCODE SafeDatabaseClose(DB *pDatabaseObject) { + BEG("SafeDatabaseClose()"); + + if(pDatabaseObject!=NULL) { + pDatabaseObject->close(pDatabaseObject, 0); + } + + END(); + return SQ_PASS; +} + +/* +------------------------------------------------------------------------------- + This initializes the DBTs for a series of DB_SET / DB_NEXT calls +------------------------------------------------------------------------------- +*/ +void SetDBTs(SQ_CHAR *pszAccount, SQRL_ASSOCIATIONS *pSqrlAssoc, DBT *pKey, DBT *pIndex, DBT *pData) { + BEG("SetDBTs()"); + + memset(pKey, 0, sizeof(DBT)); + memset(pIndex, 0, sizeof(DBT)); + memset(pData, 0, sizeof(DBT)); + + pKey->data=pszAccount; + pKey->size=strlen(pszAccount); + + pIndex->data=pSqrlAssoc->szSqrlUser; + pIndex->ulen=USER_ID_FIELD_SIZ; + pIndex->flags=DB_DBT_USERMEM; + + pData->data=&pSqrlAssoc->AssocRecData; + pData->ulen=sizeof(ASSOC_REC_DATA); + pData->flags=DB_DBT_USERMEM; + + END(); +} + +/* +=============================================================================== + ACCT KEY CREATOR (callback) +------------------------------------------------------------------------------- + This is the Account index key synthesizing callback. It provides the + key for the Secondary Account index file via the file association. +------------------------------------------------------------------------------- +*/ +int AcctKeyCreator(DB *p2ndDB, const DBT *p1stKey, const DBT *p1stData, DBT *p2ndKey) { + BEG("AcctKeyCreator()"); + LOG("IN: p1stKey->data: %s", p1stKey->data); + LOG("IN: p1stData->data->szAccount: %s", ((ASSOC_REC_DATA *)(p1stData->data))->szAccount); + + // (Only uses 1stData and 2ndKey) + + // zero the result DBT + memset(p2ndKey, 0, sizeof(DBT)); + + // set the ACCOUNTS record of the primary DBT as our Secondary Key + p2ndKey->data=p1stData->data; + + int len=strlen(p1stData->data); + if(len==0) { + // if the key is null we create an szNull key ("") + len++; + } + // set the username's length + p2ndKey->size=len; + + LOG("OUT: p2ndKey->data->pAccount: %s", ((ASSOC_REC_DATA *)(p2ndKey->data))->szAccount); + LOG("OUT: p2ndKey->size: %d", p2ndKey->size); + END(); + + // return that we should index this key + return 0; +} + +/* +=============================================================================== + SQRL KEY CREATOR (callback) +------------------------------------------------------------------------------- + This is the PublicKey index key synthesizing callback. It provides the + key for the Secondary PublicKey index file via the file association. +------------------------------------------------------------------------------- +*/ +int SqrlKeyCreator(DB *p2ndDB, const DBT *p1stKey, const DBT *p1stData, DBT *p2ndKey) { + BEG("SqrlKeyCreator()"); + LOG("IN: p1stKey->data: %s", p1stKey->data); + LOG("IN: p1stData->data->szAccount: %s", ((ASSOC_REC_DATA *)(p1stData->data))->szAccount); + + // (Only uses 1stData and 2ndKey) + +// mov edi, p2ndKey ; get our result DBT pointer +// invoke FillMemory, edi, SIZEOF DBT, NULL ; zero the result DBT + memset(p2ndKey, 0, sizeof(DBT)); + + SQ_BYTE *pSqrlID=((ASSOC_REC_DATA *)(p1stData->data))->aSqrlPublicIdentity; + +//[ + LOG("pSqrlID:"); + LOG("[]", pSqrlID, BINARY_KEY_LEN); +//] + // if we have a SQRL ID, we index it + + // If the SqrlPublicIdentity (IDK) is all zeros, assume we don't have one + // there's only a 1 in 2^256 chance the IDK is all zeros + for(int i=0; idata=pSqrlID; + p2ndKey->size=BINARY_KEY_LEN; +//[ + LOG("OUT: p2ndKey->data"); + LOG("[]", p2ndKey->data, p2ndKey->size); +//] + END(); + // indicate we should index this key + return 0; + } + } + LOG("OUT: No SqrlID, DB_DONOTINDEX"); + END(); + + // remove NULL indexes + return DB_DONOTINDEX; +} + +/* +=============================================================================== + NIGHTLY ABANDONED INVITATION SWEEP +------------------------------------------------------------------------------- + This enumerates though the main database in primary key sequence, checking + for any records whose szSqrlPublicKey begins with '.' which would flag it + as a record created as an invitation which has not yet been associated with + a SQRL ID, which would accept the invitation, replacing the '.' char prefix + with a base64url SQRL public key. For any '.' records we find, we check the + record's age. If the invitation has been outstanding for more than two + weeks (14 days) we delete the invitation. +=============================================================================== +*/ +void SweepNightlyAbandonedInvitations() { + BEG("SweepNightlyAbandonedInvitations()"); + SQ_QWORD CurrentTime; + DBC *pCursor; + DBT KeyDBT; + DBT DataDBT; + DBT SecondaryDBT; + SQRL_ASSOCIATIONS SqrlRecord; + ASSOC_REC_DATA *pAssocRecData=&SqrlRecord.AssocRecData; + + int DBmode; + + // get 'now' for the last-accessed age of any abandoned SQRL DB records + SQ_GetSystemTimeAsFileTime(&CurrentTime); + + // create a cursor to enumerate over the secondary Sqrl ID index + if(pSqrlDB->cursor(pSqrlDB, NULL, &pCursor, 0)!=0) { + END(); + return; + } + + memset(&SecondaryDBT, 0, sizeof(DBT)); + SecondaryDBT.data=&"."; + SecondaryDBT.size=1; + + // setup our user buffers to receive the enumerated data + memset(&KeyDBT, 0, sizeof(DBT)); + KeyDBT.data=&SqrlRecord; + KeyDBT.ulen=USER_ID_FIELD_SIZ; + KeyDBT.flags=DB_DBT_USERMEM; + + memset(&DataDBT, 0, sizeof(DBT)); + DataDBT.data=pAssocRecData; + DataDBT.ulen=sizeof(ASSOC_REC_DATA); + DataDBT.flags=DB_DBT_USERMEM; + + DBmode=DB_SET_RANGE; + while(1) { + // access the first or next record of the DB in SQRL ID sequence + if(pCursor->pget(pCursor, (DBT*)&SecondaryDBT, (DBT*)&KeyDBT, (DBT*)&DataDBT, DBmode)!=0) { + // no more records + break; + } + DBmode=DB_NEXT; + + // the 'get' returned zero, so we DID retrieve a new database record + // does the SQRL public key of this record begin with '.' + if(pAssocRecData->aSqrlPublicIdentity[0]!='.') { + // if not, we're done here (all the '.' records come first) + break; + } + + // we have an invitation record, so let's check its age... + if(SQ_GetFileTimeAgeInMinutes(&pAssocRecData->SqrlLastActivityDate, &CurrentTime)<60*24*14) { + // keep it + continue; + } + + // after 14 days, rescind the invitation + // we found an old invitation beginning with '.' so let's delete it + if(pCursor->del(pCursor, 0)!=0) { + // it failed + break; + } + } // back to while() + + // close our enumeration cursor + pCursor->close(pCursor); + + // to protect from crashing write the updates now + SyncAllBDB(); + + END(); +} + +/* +=============================================================================== + NIGHTLY ABANDONED AUTHENTICATIONS SWEEP +------------------------------------------------------------------------------- + When a user authenticates with an unknown SQRL identity, a SQRL record is + created and this authentication is reported to the webserver so that it can + associate this new authentication record with a webserver account. Since it + is possible for a webserver to drop the ball on this, we perform a nightly + sweep of the SQRL database looking for any "abandoned" unassociated records. + Since we sweep only once every 24 hours, we delete any records older than 24 + hours at the time of the sweep. NOTE: We enumerate records by secondary key + (szAccount) where we allow duplicate keys, since we might have multiple SQRL + identities associated with a single webserver account. So we'll have multiple + records with the same szAccount key. THIS sweep for abandoned records will be + efficient since our secondary key is sorted and our target abandoned records + will have NULL szAccount fields so they will be the first records enumerated. +=============================================================================== +*/ +void SweepNightlyAbandonedAuthentications() { + BEG("SweepNightlyAbandonedAuthentications()"); + SQ_QWORD CurrentTime; + DBC *pCursor; + DBT KeyDBT; + DBT DataDBT; + DBT SecondaryDBT; + SQRL_ASSOCIATIONS SqrlRecord; + ASSOC_REC_DATA *pAssocRecData=&SqrlRecord.AssocRecData; + + // get 'now' for the last-accessed age of any abandoned SQRL DB records + SQ_GetSystemTimeAsFileTime(&CurrentTime); + + // create a cursor to enumerate over the secondary Sqrl ID index + if(pAcctDB->cursor(pAcctDB, NULL, &pCursor, 0)!=0) { + END(); + return; + } + + memset(&SecondaryDBT, 0, sizeof(DBT)); + SecondaryDBT.data=(char *)pszNull; + SecondaryDBT.size=1; + + // setup our user buffers to receive the enumerated data + memset(&KeyDBT, 0, sizeof(DBT)); + KeyDBT.data=&SqrlRecord; + KeyDBT.ulen=USER_ID_FIELD_SIZ; + KeyDBT.flags=DB_DBT_USERMEM; + + memset(&DataDBT, 0, sizeof(DBT)); + DataDBT.data=&SqrlRecord.AssocRecData; + DataDBT.ulen=sizeof(ASSOC_REC_DATA); + DataDBT.flags=DB_DBT_USERMEM; + + int mode=DB_SET_RANGE; + + while(1) { + // access the first or next record of the DB in SQRL ID sequence + if(pCursor->pget(pCursor, &SecondaryDBT, &KeyDBT, &DataDBT, mode)!=0) { + break; + } + + // the 'get' returned zero, so we DID retrieve a new database record + // does the retrieved record have a zero-length szAccount (key)? + if(strlen(pAssocRecData->szAccount)>0) { + // as soon as we hit a non-null key, we're done + break; + } + + // prep for retrieving a series of values + mode=DB_NEXT; + + // we have an abandoned record (no associated webserver account) + // so let's check its age... + // if it's been at least 4 hours, remove the record + if(SQ_GetFileTimeAgeInMinutes(&pAssocRecData->SqrlLastActivityDate, &CurrentTime)<60*4) { + // otherwise keep it + continue; + } + + // we found a record older than four hours with no webserver association + // so let's delete it + if(pCursor->del(pCursor, 0)!=0) { + // if this fails we're done + break; + } + } + + // close our enumeration cursor + pCursor->close(pCursor); + + // to protect from crashing write the updates now + SyncAllBDB(); +} + +/* +=============================================================================== + DATABASE SWEEP THREAD +=============================================================================== +*/ +void *DatabaseSweepThread(SQ_VOID *Dummy) { + time_t EpochTime=time(NULL); + struct tm LocalTime=*localtime(&EpochTime); + int LastSweepDay=LocalTime.tm_wday; + + // Check at the 30-sec mark (the first check is not less than 30 sec from now) + sleep(90-LocalTime.tm_sec); + + while(SqrlApiRunning==SQ_TRUE) { + EpochTime=time(NULL); + LocalTime=*localtime(&EpochTime); +//. LOG("DatabaseSweepThread: Checking for day change " +//. "%d:%02d:%02d", LocalTime.tm_hour, LocalTime.tm_min, LocalTime.tm_sec); + + if(LocalTime.tm_wday!=LastSweepDay) { + SweepNightlyAbandonedInvitations(); + SweepNightlyAbandonedAuthentications(); + + // Wait again for the next day + LastSweepDay=LocalTime.tm_wday; + } + sleep(60); // seconds + } + return NULL; +} + +/* +============================================================================== + TERMINATE DATA SWEEPER +------------------------------------------------------------------------------- + We awaken the sleeping thread by kicking it out of the SleepEx call at which + point the fact that "SqrlApiRunning" has been reset will terminate the thread. +=============================================================================== +*/ +void TerminateDatabaseSweeper() { + BEG("TerminateDatabaseSweeper()"); + + if(DBSweepThreadId!=0) { + if(pthread_cancel(DBSweepThreadId)!=0) { + LOG("Error: Unable to cancel thread"); + } + + /* Join with thread to see what its exit status was */ + void *result; + if(pthread_join(DBSweepThreadId, &result)!=0) { + LOG("Error: Unable to join thread"); + } + if(result==PTHREAD_CANCELED) { + LOG("DBSweepThread cancelled, result=%d", result); + DBSweepThreadId=0; + } + else { + LOG("DBSweepThread not cancelled, result=%d", result); + } + } + END(); +} + +/* +=============================================================================== + GET DATABASE PATHNAME +=============================================================================== +*/ +void GetDatabasePathname(SQ_CHAR *pszDatabasePath) { + BEG("GetDatabasePathname()"); + // get our module's full pathname for locating the database files + +//. Don't know what to do here... just use the current directory + + strcpy(pszDatabasePath, ""); + + END(); +} + +/* +============================================================================ + SYNC ALL BDB + -------------------------------------------------------------------------- + Berkeley DB =NEVER= flushes RAM buffers to disk. So this leaves us + vulnerable to crashing. So we flush the caches after any modification. +---------------------------------------------------------------------------- +*/ +void SyncAllBDB() { + BEG("SyncAllBDB()"); + + pMainDB->sync(pMainDB, 0); + pMainDB->sync(pAcctDB, 0); + pMainDB->sync(pSqrlDB, 0); + pMainDB->sync(pDeadDB, 0); + + END(); +} + +/* +=============================================================================== + DELETE SQRL DATABASE FILES +=============================================================================== +*/ +void DeleteSqrlDatabaseFiles() { + BEG("DeleteSqrlDatabaseFiles()"); + SQ_CHAR szDatabaseFile[SQ_MAX_PATH]; + + GetDatabasePathname(szDatabaseFile); + strcat(szDatabaseFile, pszMainDBname); + remove(szDatabaseFile); + + GetDatabasePathname(szDatabaseFile); + strcat(szDatabaseFile, pszAcctDBname); + remove(szDatabaseFile); + + GetDatabasePathname(szDatabaseFile); + strcat(szDatabaseFile, pszSqrlDBname); + remove(szDatabaseFile); + + GetDatabasePathname(szDatabaseFile); + strcat(szDatabaseFile, pszDeadDBname); + remove(szDatabaseFile); + + END(); +} + +/* +=============================================================================== + OPEN SQRL DATABASE FILES + ------------------------------------------------------------------------------ + This opens the three SQRL account database files, the primary and + both secondary indexes, and associates the two secondary indexes + to the primary through the two key creator callback functions. +------------------------------------------------------------------------------- +*/ +SQ_RCODE OpenSqrlDatabaseFiles() { + BEG("OpenSqrlDatabaseFiles()"); + + // Create the PRIMARY DB + pMainDB=OpenBDB(pszMainDBname, /*AllowDups=*/SQ_FALSE); + if(pMainDB==NULL) { + LOG("Unable to create %s", pszMainDBname); + END(); + return SQ_FAIL; + } + + // Create the Account DB + // associate our secondary index to track primary changes + + pAcctDB=OpenBDB(pszAcctDBname, /*AllowDups=*/SQ_TRUE); + if(pAcctDB==NULL) { + LOG("Unable to create %s", pszAcctDBname); + END(); + return SQ_FAIL; + } +//[check return value?] + pMainDB->associate(pMainDB, NULL, pAcctDB, AcctKeyCreator, 0); + + // Create the Sqrl DB + // associate our secondary index to track primary changes + + pSqrlDB=OpenBDB(pszSqrlDBname, /*AllowDups=*/SQ_FALSE); + if(pSqrlDB==NULL) { + LOG("Unable to create %s", pszSqrlDBname); + END(); + return SQ_FAIL; + } +//[check return value?] + pMainDB->associate(pMainDB, NULL, pSqrlDB, SqrlKeyCreator, 0); + + // Create the Dead DB + pDeadDB=OpenBDB(pszDeadDBname, /*AllowDups=*/SQ_FALSE); + if(pDeadDB==NULL) { + LOG("Unable to create %s", pszDeadDBname); + END(); + return SQ_FAIL; + } + + // create our background database sweeper thread + + int err=pthread_create(&DBSweepThreadId, NULL, &DatabaseSweepThread, NULL); + if(err!=0) { + LOG("Error: Unable to create thread: %s", strerror(err)); + } + else { + LOG("DatabaseSweepThread created successfully"); + } + + END(); + return SQ_PASS; +} +/* +============================================================================ + CLOSE BERKELEY DBs + -------------------------------------------------------------------------- + This closes the SQRL database files after flushing any dirty caches. +---------------------------------------------------------------------------- +*/ +SQ_RCODE CloseBerkeleyDBs() { + BEG("CloseBerkeleyDBs()"); + + // we must first terminate our background cleanup sweeper thread + TerminateDatabaseSweeper(); + + // now we're able to close our databases + SafeDatabaseClose(pAcctDB); + pAcctDB=NULL; + + SafeDatabaseClose(pSqrlDB); + pSqrlDB=NULL; + + SafeDatabaseClose(pMainDB); + pMainDB=NULL; + + SafeDatabaseClose(pDeadDB); + pDeadDB=NULL; + + END(); + return SQ_PASS; +} + +/* +============================================================================ + STORE SQRL RECORD + -------------------------------------------------------------------------- + Given a pointer a SqrlDemoRecord, this stores it into the SQRL database. + If the record exists, its RecordNumber index will be non-NULL, so we'll + overwrite any existing record with the same index. If the index is NULL, + this is a new record, so bump the index count, fill it in, and save it. +---------------------------------------------------------------------------- +*/ +SQ_RCODE StoreSqrlRecord(SQRL_ASSOCIATIONS *pSqrlDataRecord) { + BEG("StoreSqrlRecord()"); + SQ_RCODE rc=SQ_FAIL; + ASSOC_REC_DATA *pAssocRecData=&pSqrlDataRecord->AssocRecData; + DBT KeyDBT; + DBT DataDBT; + + LOG("Storing Association for SQRL: %s and Acct: %s", + pSqrlDataRecord->szSqrlUser, pAssocRecData->szAccount); + + if(strlen(pSqrlDataRecord->szSqrlUser)>0) { + // This record already exists, just update it + } + else { + // Assign a new primary index for this record + GetUnique12charNut(pSqrlDataRecord->szSqrlUser, /*Null-Terminate=*/SQ_TRUE); + } + + // set the timestamp for this write + SQ_GetSystemTimeAsFileTime(&pAssocRecData->SqrlLastActivityDate); + + memset(&KeyDBT, 0, sizeof(KeyDBT)); + KeyDBT.data=&pSqrlDataRecord->szSqrlUser; + KeyDBT.size=sizeof(pSqrlDataRecord->szSqrlUser); + + memset(&DataDBT, 0, sizeof(DataDBT)); + DataDBT.data=&pSqrlDataRecord->AssocRecData; + DataDBT.size=sizeof(ASSOC_REC_DATA); + + if(pMainDB->put(pMainDB, NULL, &KeyDBT, &DataDBT, 0)==0) { + rc=SQ_PASS; + } + + // to protect from crashing write the updates now + SyncAllBDB(); + + END(); + return rc; +} + +/* +=============================================================================== + GET RECORD BY USER ID +------------------------------------------------------------------------------- + Given a user-supplied buffer and 12-character User ID index: Retrieve + a SQRL association record to the user's buffer. Return ZERO on success. +------------------------------------------------------------------------------- +*/ +SQ_RCODE GetRecordByUserID(SQRL_ASSOCIATIONS *pSqrlRecord, SQ_CHAR *pszUserId) { + BEG("GetRecordByUserID()"); + SQ_RCODE rc=SQ_FAIL; + SQ_CHAR SqrlUser[USER_ID_FIELD_SIZ]; // 16 + DBT Index; + DBT Data; + + memset(SqrlUser, 0, sizeof(SqrlUser)); + strncpy(SqrlUser, pszUserId, USER_ID_LEN); // 12 chars + memcpy(pSqrlRecord->szSqrlUser, SqrlUser, USER_ID_FIELD_SIZ); + + memset(&Index, 0, sizeof(DBT)); + Index.data=SqrlUser; + Index.size=USER_ID_FIELD_SIZ; + + memset(&Data, 0, sizeof(DBT)); + Data.data=&pSqrlRecord->AssocRecData; + Data.ulen=sizeof(ASSOC_REC_DATA); + Data.flags=DB_DBT_USERMEM; + + if(pMainDB->get(pMainDB, NULL, &Index, &Data, 0)==0) { + rc=SQ_PASS; + } + END(); + return rc; +} + +/* +=============================================================================== + GET RECORD BY SQRL ID +------------------------------------------------------------------------------- + Given a user-supplied buffer and 44-character ASCII SQRL ID, retrieve + a SQRL association into the user's buffer & return ZERO on success. +------------------------------------------------------------------------------- +*/ +SQ_RCODE GetRecordBySqrlID(SQRL_ASSOCIATIONS *pSqrlRecord, SQ_CHAR *pszSqrlID) { + BEG("GetRecordBySqrlID()"); + SQ_RCODE rc=SQ_FAIL; + SQ_BYTE LookupKey[32]; + DBT SecondaryKey; + DBT Index; + DBT Data; + + memset(&SecondaryKey, 0, sizeof(DBT)); +//. what if the conversion fails? + SqrlCvrtFromBase64(LookupKey, BINARY_KEY_LEN, pszSqrlID, ASCII_KEY_LEN); + + SecondaryKey.data=LookupKey; + SecondaryKey.size=BINARY_KEY_LEN; + + memset(&Index, 0, sizeof(DBT)); + Index.data=pSqrlRecord; + Index.ulen=USER_ID_FIELD_SIZ; + Index.flags=DB_DBT_USERMEM; + + memset(&Data, 0, sizeof(DBT)); + Data.data=&pSqrlRecord->AssocRecData; + Data.ulen=sizeof(ASSOC_REC_DATA); + Data.flags=DB_DBT_USERMEM; + + if(pSqrlDB->pget(pSqrlDB, NULL, &SecondaryKey, &Index, &Data, 0)==0) { + rc=SQ_PASS; + } + END(); + return rc; +} + +/* +=============================================================================== + GET RECORD BY SQRL KEY +------------------------------------------------------------------------------ + Given a user-supplied buffer and 32-byte SQRL Identity binary key, retrieve + a SQRL demo association into the user's buffer and return ZERO on success. +------------------------------------------------------------------------------- +*/ +SQ_RCODE GetRecordBySqrlKey(SQRL_ASSOCIATIONS *pSqrlRecord, SQ_BYTE *p_idk) { + BEG("GetRecordBySqrlKey()"); + SQ_RCODE rc=SQ_FAIL; + DBT SecondaryKey; + DBT Index; + DBT Data; + + memset(&SecondaryKey, 0, sizeof(DBT)); + SecondaryKey.data=p_idk; + SecondaryKey.size=BINARY_KEY_LEN; + + memset(&Index, 0, sizeof(DBT)); + Index.data=pSqrlRecord; + Index.ulen=USER_ID_FIELD_SIZ; + Index.flags=DB_DBT_USERMEM; + + memset(&Data, 0, sizeof(DBT)); + Data.data=&pSqrlRecord->AssocRecData; + Data.ulen=sizeof(ASSOC_REC_DATA); + Data.flags=DB_DBT_USERMEM; + + if(pSqrlDB->pget(pSqrlDB, NULL, &SecondaryKey, &Index, &Data, 0)==0) { + rc=SQ_PASS; + } + + END(); + return rc; +} + +/* +=============================================================================== + GET RECORD BY INVITATION +------------------------------------------------------------------------------- + Given a user-supplied buffer and 20-char Invitation index: Retrieve + a SQRL demo record into the user's buffer andreturn ZERO on success. +------------------------------------------------------------------------------- +*/ +SQ_RCODE GetRecordByInvitation(SQRL_ASSOCIATIONS *pSqrlRecord, SQ_CHAR *pszInvitation) { + BEG("GetRecordByInvitation()"); + + // The invitation is stored in the same field as the Sqrl idk and treated as binary data + // 32 byte idk: 0123456789abcdef0123456789abcdef + // 21 char inv: .01234567890123456789 + SQ_RCODE rc=SQ_FAIL; +// SQ_CHAR szSqrlIdentity[ASCII_BUF_LEN]; + SQ_BYTE aSqrlIdentity[BINARY_KEY_LEN]; +// memset(szSqrlIdentity, 0, ASCII_BUF_LEN); + memset(aSqrlIdentity, 0, BINARY_KEY_LEN); + + // invitations are flagged with a PERIOD prefix +// szSqrlIdentity[0]='.'; + aSqrlIdentity[0]='.'; + + // copy the provided SZ string into the assembly buffer + null + strncpy((SQ_CHAR *)&aSqrlIdentity[1], pszInvitation, BINARY_KEY_LEN-1); + + // lookup the SQRL associations record by invitation + if(GetRecordBySqrlKey(pSqrlRecord, aSqrlIdentity)==SQ_PASS) { + rc=SQ_PASS; + } + + END(); + return rc; +} + +/* +============================================================================ + DELETE SQRL RECORD +---------------------------------------------------------------------------- +*/ +SQ_RCODE DeleteSqrlRecord(SQRL_ASSOCIATIONS *pSqrlAssocRec) { + BEG("DeleteSqrlRecord()"); + SQ_RCODE rc=SQ_FAIL; + DBT Index; + + memset(&Index, 0, sizeof(DBT)); + + Index.data=pSqrlAssocRec; + Index.size=USER_ID_FIELD_SIZ; + + if(pMainDB->del(pMainDB, NULL, &Index, 0)==0) { + rc=SQ_PASS; + } + SyncAllBDB(); + + END(); + return rc; +} + +/* +============================================================================ + LOG SUPERSEDED ID +---------------------------------------------------------------------------- + Given a pointer to a 32-byte Superseded identity buffer, this stores it + into the dead SQRL identities database. We do not need to check for the + existing identity since this DDB do not allow DUPS and any existing rec + will simply be overwritten. This is faster than first checking and not + store if the record is found. +---------------------------------------------------------------------------- +*/ +SQ_RCODE LogSupersededID(SUPERSEDED_IDENTITIES *pIdentityToLog) { + BEG("LogSupersededID()"); + SQ_RCODE rc=SQ_FAIL; + DBT KeyDBT; + DBT DataDBT; +//[ + LOG("Logging Superseded ID: "); + LOG("[]", pIdentityToLog->aSupersededIdentity, BINARY_KEY_LEN); +//] + memset(&KeyDBT, 0, sizeof(KeyDBT)); + + KeyDBT.data=pIdentityToLog->aSupersededIdentity; + KeyDBT.size=BINARY_KEY_LEN; + + // no associated data to be stored in the log + memset(&DataDBT, 0, sizeof(DBT)); + + if(pDeadDB->put(pDeadDB, NULL, &KeyDBT, &DataDBT, 0)==0) { + rc=SQ_PASS; + } + + // to protect from crashing write the updates now + SyncAllBDB(); + + END(); + return rc; +} + +/* +=============================================================================== + CHECK FOR SUPERSEDED ID +------------------------------------------------------------------------------- + Given a pointer to a 32-byte ID to check, this returns ZERO if the ID =WAS= + found in the Superseded identities log. +------------------------------------------------------------------------------- +*/ +SQ_RCODE CheckForSupersededID(SUPERSEDED_IDENTITIES *pIdentityToCheck) { + BEG("CheckForSupersededID()"); + SQ_RCODE rc=SQ_FAIL; + DBT Index; + DBT Data; + + memset(&Index, 0, sizeof(DBT)); + Index.data=pIdentityToCheck->aSupersededIdentity; + Index.size=BINARY_KEY_LEN; + + // no associated data to be stored in the log + memset(&Data, 0, sizeof(DBT)); + Data.ulen=0; // no data + Data.flags=DB_DBT_USERMEM; + + if(pDeadDB->get(pDeadDB, NULL, &Index, &Data, 0)==0) { + rc=SQ_PASS; + } + + END(); + return rc; +} + +/* +=============================================================================== + GET LIST OF ASSOCIATIONS +------------------------------------------------------------------------------- + The Add/Remove/List queries each return a list of SQRL IDs, User Handles and + the Status currently associated with the account after the query processing. + This common function handles the return of that list from any of functions. + It formats the SQRL Association data and returns a set of CR/LF terminated + lines in a single global alloc containing a single szString. +=============================================================================== +*/ +SQ_CHAR *GetListOfAssociations(SQ_CHAR *pszAccount) { + BEG("GetListOfAssociations()"); + LOG("Account: %s", pszAccount); + DBC *pCursor; + DBT Key; + DBT Index; + DBT Data; + SQ_CHAR szLineItem[512]; + SQ_DWORD TotalLength; + SQ_CHAR szUrlEncodedName[256]; + SQ_CHAR *pszBuffer; + SQRL_ASSOCIATIONS SqrlAssoc; + SQRL_ASSOCIATIONS *SAptr; + int DBmode; + + pszBuffer=NULL; + pCursor=NULL; + + // create a cursor to enumerate over the SECONDARY database + if(pAcctDB->cursor(pAcctDB, NULL, &pCursor, 0)!=0) { + END(); + return (SQ_CHAR *)GlobalAlloc(1); + } + + TotalLength=0; + SetDBTs(pszAccount, &SqrlAssoc, &Key, &Index, &Data); + DBmode=DB_SET; + while(1) { + // access the first or next record of the DB in SQRL ID sequence + if(pCursor->pget(pCursor, (DBT*)&Key, (DBT*)&Index, (DBT*)&Data, DBmode)!=0) { + // if we hit the end, perhaps we succeeded? + break; + } + + LOG("Key.Data:"); + LOG("[]", Key.data, Key.size); + LOG("Index.pData:"); + LOG("[]", Index.data, Index.size); + LOG("Data.pData:"); + LOG("[]", Data.data, Data.size); + + DBmode=DB_NEXT; + SAptr=&SqrlAssoc; + + if(strcmp(SAptr->AssocRecData.szAccount, pszAccount)!=0) { + break; + } + + // make sure the user's provided name is URL safe + UrlEncode(szUrlEncodedName, SAptr->AssocRecData.szUserHandle); + + SQ_CHAR *pszInvite=(char *)pszNull; + if(SAptr->AssocRecData.aSqrlPublicIdentity[0]=='.') { + pszInvite=(SQ_CHAR *)&SAptr->AssocRecData.aSqrlPublicIdentity[1]; + } + + // get the total length of this formatted line item + TotalLength+=sprintf(szLineItem, pszEnumerationFormat, + SAptr->szSqrlUser, + SAptr->AssocRecData.szAccount, + szUrlEncodedName, + SAptr->AssocRecData.szStatus, + pszInvite); +//[ +LOG("Association: %s", szLineItem); +//] + } // back to while() + + if(TotalLength==0) { + // we didn't have even ONE line to output + pCursor->close(pCursor); + END(); + return (SQ_CHAR *)GlobalAlloc(1); + } + + pszBuffer=GlobalAlloc(TotalLength+1); + + // we did have at least one line to output... so let's do that now + SetDBTs(pszAccount, &SqrlAssoc, &Key, &Index, &Data); + DBmode=DB_SET; + while(1) { + // now let's get the first or next record... and check + if(pCursor->pget(pCursor, (DBT*)&Key, (DBT*)&Index, (DBT*)&Data, DBmode)!=0) { + break; + } + DBmode=DB_NEXT; + SAptr=&SqrlAssoc; + + if(strcmp(SAptr->AssocRecData.szAccount, pszAccount)!=0) { + pCursor->close(pCursor); + END(); + return pszBuffer; + } + + // make sure the user's provided name is URL safe + UrlEncode(szUrlEncodedName, SAptr->AssocRecData.szUserHandle); + + // get length of the string we have built so far + // hold it in ECX to sum for format insertion + SQ_CHAR *pszInvite=(char *)pszNull; + + if(SAptr->AssocRecData.aSqrlPublicIdentity[0]=='.') { + pszInvite=(SQ_CHAR *)&SAptr->AssocRecData.aSqrlPublicIdentity[1]; + } + + // add the formatted item to the end of the growing string + sprintf(&pszBuffer[strlen(pszBuffer)], pszEnumerationFormat, + SAptr->szSqrlUser, + SAptr->AssocRecData.szAccount, + &szUrlEncodedName, + SAptr->AssocRecData.szStatus, + pszInvite); + } // back to while() + + // close our enumeration cursor + pCursor->close(pCursor); + + // return our global alloc containing the string + END(); + return pszBuffer; + } + +/* +=============================================================================== + UPDATE BY ACCOUNT +------------------------------------------------------------------------------- + This updates or deletes one or more SQRL-account associations. If a UserHandle + is provided, only the association matching the UserHandle will be updated or + deleted. If no UserHandle is provided, =EVERY= association with the matching + account will be updated or deleted. +=============================================================================== +*/ +void UpdateByAccount(QUERY_PARAMS *pQueryParams, SQ_BOOL Remove) { + BEG("UpdateByAccount()"); + DBC *pCursor; + DBT Key; + DBT Index; + DBT Data; + SQRL_ASSOCIATIONS SqrlAssoc; + ASSOC_REC_DATA *pAssocRecData=&SqrlAssoc.AssocRecData; + int DBmode; + + // create a cursor to enumerate over the SECONDARY database + // get a pointer to our secondary Account database + if(pAcctDB->cursor(pAcctDB, NULL, &pCursor, 0)!=0) { + END(); + return; + } + + memset(&Key, 0, sizeof(DBT)); + memset(&Index, 0, sizeof(DBT)); + memset(&Data, 0, sizeof(DBT)); + + Key.data=pQueryParams->pszAccount; + Key.size=strlen(Key.data); + + // point our get key data to the Sqrl Record pointer + Index.data=&SqrlAssoc; + Index.ulen=USER_ID_FIELD_SIZ; + Index.flags=DB_DBT_USERMEM; + + // set the start of the record data + Data.data=&SqrlAssoc.AssocRecData; + Data.ulen=sizeof(ASSOC_REC_DATA); + Data.flags=DB_DBT_USERMEM; + + DBmode=DB_SET; + while(1) { + // access the first or next record of the DB in SQRL ID sequence + if(pCursor->pget(pCursor, (DBT*)&Key, (DBT*)&Index, (DBT*)&Data, DBmode)!=0) { + // if we hit the end we're finished + break; + } + DBmode=DB_NEXT; + + // make sure we found a record with a matching Account + if(strcmp(pAssocRecData->szAccount, pQueryParams->pszAccount)!=0) { + // if not, we're done + break; + } + + // we found a candidate. so if we were provided a UserHandle, we + // check for a match. Otherwise we perform the requested operation. + if(pQueryParams->pszUserHandle!=NULL) { + // do the szUserHandles match? + if(strcmp(pAssocRecData->szUserHandle, pQueryParams->pszUserHandle)!=0) { + // if not a match, we'll keep looking + continue; + } + } + // we either have no UserHandle, or the UserHandle provided is a match. + // so we perform the requested action on this record... + if(Remove) { + pCursor->del(pCursor, 0); + } + else { + // and we conditionally update the UserHandle and the Status strings + if(pQueryParams->pszUserHandle!=pszNull) { + strcpy(pAssocRecData->szUserHandle, pQueryParams->pszUserHandle); + } + if(pQueryParams->pszStatus!=pszNull) { + strcpy(pAssocRecData->szStatus, pQueryParams->pszStatus); + } + // now we put the updated data back right where we found it. + pCursor->put(pCursor, (DBT*)&Index, (DBT*)&Data, DB_CURRENT); + } + } // back to while() + + // close our enumeration cursor + pCursor->close(pCursor); + // to protect from crashing write the updates now + SyncAllBDB(); + END(); +} + +//.[ For development +char *GetBerkeleyMainDatabase() { + DBC *pCursor; + + // start with a null-terminated empty string + char *pszList=GlobalAlloc(1); + + char *pszFormat= + "UserId(KEY): %s\r\n" + " Account: %s\r\n" + " UserHandle: %s\r\n" + " Status: %s\r\n" + "%s\r\n" + " SUK: %s\r\n" + " VUK: %s\r\n" + " Accessed: %s" + "\r\n"; + char *pszInvite=" Invitation: "; + char *pszSqrlId="SqrlId(IDK): %02x%02x%02x%02x%02x%02x%02x%02x..."; + char szSqrlIdInvite[64]; // the effective size of the above strings + int TotalLen=1; // allow for null terminator + + // Don't check for errors, assume everything works + pMainDB->cursor(pMainDB, NULL, &pCursor, 0); + DBT key, data; + memset(&key, 0, sizeof(DBT)); + memset(&data, 0, sizeof(DBT)); + + while ((pCursor->get(pCursor, (DBT*)&key, (DBT*)&data, DB_NEXT)) == 0) { + ASSOC_REC_DATA*ptr=(ASSOC_REC_DATA*)(data.data); + if(ptr->aSqrlPublicIdentity[0]=='.') { + strcpy(szSqrlIdInvite, pszInvite); + memcpy(strchr(szSqrlIdInvite, '\0'), &ptr->aSqrlPublicIdentity[1], 20); + szSqrlIdInvite[strlen(pszInvite)+20]='\0'; + } + else { + sprintf(szSqrlIdInvite, pszSqrlId, + ptr->aSqrlPublicIdentity[0], + ptr->aSqrlPublicIdentity[1], + ptr->aSqrlPublicIdentity[2], + ptr->aSqrlPublicIdentity[3], + ptr->aSqrlPublicIdentity[4], + ptr->aSqrlPublicIdentity[5], + ptr->aSqrlPublicIdentity[6], + ptr->aSqrlPublicIdentity[7]); + } + char szSUK[16+3+1]; + sprintf(szSUK, "%02x%02x%02x%02x%02x%02x%02x%02x...", + ptr->aSqrlServerUnlockKey[0], + ptr->aSqrlServerUnlockKey[1], + ptr->aSqrlServerUnlockKey[2], + ptr->aSqrlServerUnlockKey[3], + ptr->aSqrlServerUnlockKey[4], + ptr->aSqrlServerUnlockKey[5], + ptr->aSqrlServerUnlockKey[6], + ptr->aSqrlServerUnlockKey[7]); + + char szVUK[16+3+1]; + sprintf(szVUK, "%02x%02x%02x%02x%02x%02x%02x%02x...", + ptr->aSqrlVerifyUnlockKey[0], + ptr->aSqrlVerifyUnlockKey[1], + ptr->aSqrlVerifyUnlockKey[2], + ptr->aSqrlVerifyUnlockKey[3], + ptr->aSqrlVerifyUnlockKey[4], + ptr->aSqrlVerifyUnlockKey[5], + ptr->aSqrlVerifyUnlockKey[6], + ptr->aSqrlVerifyUnlockKey[7]); + + SQ_QWORD Offset1601To1970=(SQ_DWORD)0x019db1ded53e8000; + time_t LastActivity=(time_t)((ptr->SqrlLastActivityDate-Offset1601To1970)/10000000); + + TotalLen=TotalLen + +strlen(pszFormat)-strlen("%s%s%s%s%s%s%s%s") // <- number of %s's in pszFormat + +strlen(key.data) + +strlen(ptr->szAccount) + +strlen(ptr->szUserHandle) + +strlen(ptr->szStatus) + +strlen(szSqrlIdInvite) + +strlen(szSUK) + +strlen(szVUK) + +strlen("DDD MMM dd hh:mm:ss yyyy\r\n"); + pszList=realloc(pszList, TotalLen); + + sprintf(strchr(pszList, '\0'), pszFormat, + key.data, + ptr->szAccount, + ptr->szUserHandle, + ptr->szStatus, + szSqrlIdInvite, + szSUK, + szVUK, + ctime(&LastActivity)); + } + return pszList; +} + +char *GetSupersededIDs() { + DBC *pCursor; + +// start with a null-terminated empty string + char *pszList=GlobalAlloc(1); + + char *pszFormat= + " SuperIDK: %s\r\n"; + int TotalLen=1; // allow for null terminator + + // Don't check for errors, assume everything works + pDeadDB->cursor(pDeadDB, NULL, &pCursor, 0); + DBT key, data; + memset(&key, 0, sizeof(DBT)); + memset(&data, 0, sizeof(DBT)); + + while ((pCursor->get(pCursor, (DBT*)&key, (DBT*)&data, DB_NEXT)) == 0) { + SQ_BYTE *ptr=(SQ_BYTE *)(key.data); + char szIUK[16+3+1]; + sprintf(szIUK, "%02x%02x%02x%02x%02x%02x%02x%02x...", + ptr[0], + ptr[1], + ptr[2], + ptr[3], + ptr[4], + ptr[5], + ptr[6], + ptr[7]); + + TotalLen=TotalLen + +strlen(pszFormat)-strlen("%s") // <- number of %s's in pszFormat + +strlen(szIUK); + pszList=realloc(pszList, TotalLen); + + sprintf(strchr(pszList, '\0'), pszFormat, + szIUK); + } + return pszList; +} + +//] diff --git a/SSP-API-Source/dbglog.c b/SSP-API-Source/dbglog.c new file mode 100644 index 0000000..a374ffb --- /dev/null +++ b/SSP-API-Source/dbglog.c @@ -0,0 +1,211 @@ + +// dbglog.c + +#include "dbglog.h" + +SQ_BOOL bCounterReset=SQ_FALSE; + +// Detailed Log For Debugging (not thread-safe) +enum { + NumItems=128, + ItemLen=32 +}; + +static char aDebugFilter[NumItems][ItemLen]; +static char *pDebugFilter=NULL; + +SQ_RCODE ReadDebugFilter() { + // Initialize + memset(aDebugFilter, 0, NumItems*ItemLen); + pDebugFilter=&aDebugFilter[0][0]; + + FILE *pFile; + if((pFile=fopen("DebugFilter.txt", "rb"))==NULL) { + LOG("Unable to open %s", "DebugFilter.txt"); + return SQ_FAIL; + } + int i=0; + while (fgets(aDebugFilter[i], ItemLen, pFile)!=NULL) { + char *ptr=strpbrk(aDebugFilter[i], "\r\n"); + if(ptr!=NULL) *ptr='\0'; + i++; + } + fclose(pFile); + return SQ_PASS; +} + +SQ_RCODE CheckDebugFilter(char *pFunctionName) { + // Check if we have read in the file + if(pDebugFilter==NULL) { + ReadDebugFilter(); + } + int i; + for(i=0; i0x7f) { + f='x'; + break; + } + } + if(f=='c') { + // log an ASCII character array + Lprintf("\""); + for(int i=0; i +#include +#include +#include +#include + +#include "sqtypes.h" + +// For debugging +extern FILE *pLogFile; +extern SQ_BOOL bCounterReset; + +SQ_RCODE ReadDebugFilter(); +SQ_RCODE CheckDebugFilter(char *pFunctionName); +void Lprintf(const char *pFormat, ...); +void Beg(char *pFunctionName, char *pFile, int Line); +void End(char *pFile, int Line); +void Log(const char *pFormat, ...); + +// These functions are set up as macros so they can be +// completely eliminated from the code when not debugging. + +#ifndef DBG_LOG +#define BEG(S) +#define END(S) +#define LOG(A, ...) +#endif + +#ifndef BEG + #define BEG(S) Beg(S, __FILE__, __LINE__) +#endif +#ifndef END + #define END() End(__FILE__, __LINE__) +#endif +#ifndef LOG + #define LOG(A, ...) Log(A, ##__VA_ARGS__) +#endif + +#endif diff --git a/SSP-API-Source/global.c b/SSP-API-Source/global.c new file mode 100644 index 0000000..2ab84c5 --- /dev/null +++ b/SSP-API-Source/global.c @@ -0,0 +1,197 @@ + +// global.c + +#include "global.h" + +SQ_BOOL SqrlApiRunning; +QUEUE PendingAuthsQueue; +const SQ_BYTE aSystemKey[BYTES_FOR_256_BITS]; + +const char *pszNull=""; +const char *pszCRLF="\r\n"; +const char *pszNutEquals="nut="; +const char *pszUserIdWithAccount="user=%s&stat=%s&name=%s&acct=%s"; +const char *pszUserIdWithNoAccount="user=%s&stat=%s&name=%s"; +const char *pszUrlPrefix="url="; +const char *pszPathPrefix="x="; +const char *pszSqrlOnly="SqrlOnly"; +const char *pszHardLock="HardLock"; +const char *pszDisabled="Disabled"; +const char *pszRemove="Remove"; +const char *pszRekeyed="Rekeyed"; +const char *pszComma=","; + +const char *pszBlockedPrivateQuery= + "Private query to non-registered IP blocked: %s"; +const char *pszQueryTokenList[]= + {"user=", "acct=", "name=", "stat=", "invt="}; + +const char *pszNutAndCanLinkFormat= + "%snut=%s&can=%s" + ; +const char *pszQRcodeFormat= + "sqrl://%s/cli.sqrl?%snut=%s" + ; +const char *pszSQlinkFormat= + "sqrl://%s/cli.sqrl?%snut=%s&can=%s" + ; +const char *pszEnumerationFormat= + "user=%s&acct=%s&name=%s&stat=%s&invt=%s\r\n" + ; +const char *pszSqrlReplyFormat= + "ver=1\r\n" + "nut=%s\r\n" + "tif=%X\r\n" + "qry=/cli.sqrl?%snut=%s\r\n" + ; +const char *pszHttpResponseHeaderFormat= + "Expires: Mon, 01 Jan 1990 00:00:00 GMT\r\n" + "Content-Type: text/plain\r\n" + "Cache-control: no-cache\r\n" + "P3P: CP=\"NOI DSP COR NID NOR\"\r\n" + "Pragma: no-cache\r\n" + "Vary: Origin\r\n" + "Access-Control-Allow-Origin: %s\r\n" + "Connection: close\r\n" +//. "Content-Length: %d\r\n" // WriteResponseHeaders() does this +//. "\r\n" // WriteResponseHeaders()does this + ; +const char *pszHttpImageHeaderFormat= + "Expires: Mon, 01 Jan 1990 00:00:00 GMT\r\n" + "Content-Type: image/png\r\n" + "Cache-control: no-cache\r\n" + "P3P: CP=\"NOI DSP COR NID NOR\"\r\n" + "Pragma: no-cache\r\n" + "Vary: Origin\r\n" + "Access-Control-Allow-Origin: %s\r\n" + "Connection: close\r\n" +//. "Content-Length: %d\r\n" // WriteResponseHeaders() does this +//. "\r\n" // WriteResponseHeaders() does this + ; +const char *pszHttpReplyHeaderFormat= + "Content-Type: application/x-www-form-urlencoded\r\n" + "Expires: Mon, 01 Jan 1990 00:00:00 GMT\r\n" + "Cache-control: no-cache\r\n" + "Pragma: no-cache\r\n" + "Vary: Origin\r\n" + "Access-Control-Allow-Origin: %s\r\n" +//. "Content-Length: %d\r\n" // WriteResponseHeaders() does this +//. "\r\n" // WriteResponseHeaders() does this + ; + +const char *pszCfgFile=".sspapi.cfg"; + +// The CfgNames must be in the same order as the CFG enums in global.h +// Lengths are 1 less than the allocated null-terminated string size +CFG_INFO aCfgInfo[] ={ + {"MonotonicCounter=", (const char *)szMonotonicCounter, BYTES_FOR_64_BITS*2}, + {"HandlerName=", (const char *)szHandlerName, HANDLER_NAME_SIZ-1}, + {"CertFilename=", (const char *)szCertFilename, SQ_MAX_PATH-1}, + {"KeyFilename=", (const char *)szKeyFilename, SQ_MAX_PATH-1}, + {"ListenIP=", (const char *)szListenIp, SQ_IP_LEN}, + {"ListenPort=", (const char *)szListenPort, SQ_PORT_LEN}, + {"PrivateAccessIP=", (const char *)szPrivateAccessIp, SQ_IP_LEN}, + {"SystemKey=", (const char *)szSystemKey, BYTES_FOR_256_BITS*2}, + {"DatabaseKey=", (const char *)szDatabaseKey, DATABASE_KEY_LEN}, + {"TransactionLogging=", (const char *)szTransactionLogging, sizeof(char)}, + {"PublicAuthDomain=", (const char *)szPublicAuthDomain, SQ_MAX_URL-1}, + {"WebServerAuthURL0=", (const char *)szWebServerAuthUrlArray[0], SQ_MAX_URL-1}, + {"WebServerAuthURL1=", (const char *)szWebServerAuthUrlArray[1], SQ_MAX_URL-1}, + {"WebServerAuthURL2=", (const char *)szWebServerAuthUrlArray[2], SQ_MAX_URL-1}, + {"WebServerAuthURL3=", (const char *)szWebServerAuthUrlArray[3], SQ_MAX_URL-1}, + {"WebServerAuthURL4=", (const char *)szWebServerAuthUrlArray[4], SQ_MAX_URL-1}, + {"WebServerAuthURL5=", (const char *)szWebServerAuthUrlArray[5], SQ_MAX_URL-1}, + {"WebServerAuthURL6=", (const char *)szWebServerAuthUrlArray[6], SQ_MAX_URL-1}, + {"WebServerAuthURL7=", (const char *)szWebServerAuthUrlArray[7], SQ_MAX_URL-1}, + {"WebServerAuthURL8=", (const char *)szWebServerAuthUrlArray[8], SQ_MAX_URL-1}, + {"WebServerAuthURL9=", (const char *)szWebServerAuthUrlArray[9], SQ_MAX_URL-1}, +}; + +const HTTP_STATUS_LOOKUP HttpStatusLookup[]={ + {200, "200 OK"}, +// {302, "302 Found"}, + {400, "400 Bad Request"}, + {404, "404 Not Found"}, + {410, "410 Gone"} +}; + +const CLIENT_TOKEN ClientTokens[]={ + {"ver=", QUERY_VER}, + {"cmd=", QUERY_CMD}, + {"opt=", QUERY_OPT}, + {"idk=", QUERY_IDK}, + {"pidk=", QUERY_PIDK}, + {"suk=", QUERY_SUK}, + {"vuk=", QUERY_VUK} +}; +const int NumClientTokens=sizeof(ClientTokens)/sizeof(ClientTokens[0]); + +const QUERY_TOKEN QueryTokens[]={ + {"client=", QUERY_CLIENT}, + {"server=", QUERY_SERVER}, + {"ids=", QUERY_IDS}, + {"pids=", QUERY_PIDS}, + {"urs=", QUERY_URS} +}; +const int NumQueryTokens=sizeof(QueryTokens)/sizeof(QueryTokens[0]); + +const CMD_OPT_TABLE CommandTable[]={ + {"query", CMD_QUERY}, + {"ident", CMD_IDENT}, + {"enable", CMD_ENABLE}, + {"disable", CMD_DISABLE}, + {"remove", CMD_REMOVE} +}; +const int NumCommandItems=sizeof(CommandTable)/sizeof(CommandTable[0]); + +const CMD_OPT_TABLE OptionTable[]={ + {"sqrlonly", OPT_SQRLONLY}, + {"hardlock", OPT_HARDLOCK}, + {"cps", OPT_CPS_MODE}, + {"suk", OPT_SUK_REQ}, + {"noiptest", OPT_NOIPTEST} +}; +const int NumOptionItems=sizeof(OptionTable)/sizeof(OptionTable[0]); + +// Count number of characters in a UTF-8 string +int Utf8Len(char *pszUtf8) { + char *ptr=pszUtf8; + int n=0; + char c; + + while((c=*ptr)!='\0') { + if((c&0x80)==0x00) { // 0bbbbbbb + // 1 byte code + n++; + ptr++; + } + else if((c&0xe0)==0xc0) { // 110bbbbb + // 2 byte code (extra bytes are 10bbbbbb) + n++; + ptr++; + if((*ptr&0xc0)!=0x80) return 0; // UTF-8 encoding error + ptr++; + } + else if((c&0xf0)==0xe0) { // 1110bbbb) + // 3 byte code (extra bytes are 10bbbbbb) + n++; + ptr++; + if((*ptr&0xc0)!=0x80) return 0; // UTF-8 encoding error + ptr++; + if((*ptr&0xc0)!=0x80) return 0; // UTF-8 encoding error + ptr++; + } + else if((c&0xf8)==0xf0) { // 11110bbb) + // 4 byte code (extra bytes are 10bbbbbb) + n++; + ptr++; + if((*ptr&0xc0)!=0x80) return 0; // UTF-8 encoding error + ptr++; + if((*ptr&0xc0)!=0x80) return 0; // UTF-8 encoding error + ptr++; + if((*ptr&0xc0)!=0x80) return 0; // UTF-8 encoding error + ptr++; + } + } + return n; +} diff --git a/SSP-API-Source/global.h b/SSP-API-Source/global.h new file mode 100644 index 0000000..870dad5 --- /dev/null +++ b/SSP-API-Source/global.h @@ -0,0 +1,575 @@ + +// global.h + +#ifndef GLOBAL_H +#define GLOBAL_H + +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +#include "dbglog.h" +#include "sqtypes.h" +#include "sspapi.h" + +// The CfgNames must be in the same order as in CFG_INFO aCfgInfo[] in global.c +enum { + CFG_MONOTONIC_COUNTER, + CFG_HANDLER_NAME, + CFG_CERT_FILENAME, + CFG_KEY_FILENAME, + CFG_LISTEN_IP, + CFG_LISTEN_PORT, + CFG_PRIVATE_ACCESS_IP, + CFG_SYSTEM_KEY, + CFG_DATABASE_KEY, + CFG_TRANSACTION_LOGGING, + CFG_PUBLIC_AUTH_DOMAIN, + CFG_WEB_SERVER_AUTH_URL0, + CFG_WEB_SERVER_AUTH_URL1, + CFG_WEB_SERVER_AUTH_URL2, + CFG_WEB_SERVER_AUTH_URL3, + CFG_WEB_SERVER_AUTH_URL4, + CFG_WEB_SERVER_AUTH_URL5, + CFG_WEB_SERVER_AUTH_URL6, + CFG_WEB_SERVER_AUTH_URL7, + CFG_WEB_SERVER_AUTH_URL8, + CFG_WEB_SERVER_AUTH_URL9, + + CFG_NUM_ITEMS +}; +enum { + USER_ID_FIELD_SIZ =16, // 15+1 Sqrl User ID field size + USER_ID_LEN =12, // 12 chars base64url (72 bits) + SQRL_NUT_LEN =12, // 12 chars base64url (72 bits) + BINARY_KEY_LEN =32, // bytes needed for 256 bits + ASCII_KEY_LEN =43, // 32 bytes expands to 43 chars + ASCII_BUF_LEN =44, // 43 chars + Terminating null + ASCII_SIG_LEN =86, // 64 bytes expands to 86 chars + + DATABASE_KEY_LEN =32, // 32 character password key + + INVITATION_TOKEN_LEN=20, // 20 chars ASCII token string + CPS_TOKEN_LEN =24, // 24 chars base64url (144 bits) + SIGNATURE_LEN =64 // ids, pids, urs +}; +enum { + QUERY_STRING_LEN =16, + MINIMUM_CLIENT_QUERY=200, // client query must be at least + MAXIMUM_CLIENT_QUERY=4000 // make sure it's not too long +}; +enum { + QUERY_NUT =0x0001, + QUERY_CLIENT=0x0002, + QUERY_SERVER=0x0004, + QUERY_IDS =0x0008, + QUERY_PIDS =0x0010, + QUERY_URS =0x0020, + QUERY_VER =0x0040, + QUERY_CMD =0x0080, + QUERY_OPT =0x0100, + QUERY_IDK =0x0200, + QUERY_PIDK =0x0400, + QUERY_SUK =0x0800, + QUERY_VUK =0x1000 +}; +enum { + VALID_IDS =0x0001, + VALID_PIDS =0x0002, + VALID_URS =0x0004 +}; +enum{ + QUERY_MAC_INVALID =0x80000000, // bad ServerMAC from client + QUERY_NUT_INVALID =0x40000000, + PENDING_AUTH_VALID =0x20000000 +}; +enum { + CURRENT_ID_MATCH =0x0001, + PREVIOUS_ID_MATCH =0x0002, + IP_ADDRESS_MATCH =0x0004, + SQRL_DISABLED =0x0008, + CMD_NOT_SUPPORTED =0x0010, + TRANSIENT_ERROR =0x0020, + COMMAND_FAILED =0x0040, + CLIENT_FAILED =0x0080, + WRONG_SQRL_ID =0x0100, + SUPERSEDED_ID =0x0200 +}; +enum { + PATH_INFO_LEN =9, // /xxx.sqrl is 9 chars + BYTES_FOR_64_BITS =8, + BYTES_FOR_256_BITS =32, + SHA256_BYTE_LEN =32, + BLOWFISH_KEY_LEN =32, + IPV4_BYTE_LEN =4, + IPV6_BYTE_LEN =16, + PENDING_AUTH_EXP =60*60 // one hour association expiration +}; +enum { + CMD_QUERY =0x01, + CMD_IDENT =0x02, + CMD_DISABLE =0x04, + CMD_ENABLE =0x08, + CMD_REMOVE =0x10 +}; +enum { + OPT_SQRLONLY =0x01, + OPT_HARDLOCK =0x02, + OPT_NOIPTEST =0x04, + OPT_CPS_MODE =0x08, + OPT_SUK_REQ =0x10 +}; +enum { + AUTH_DISABLED =0x01, // static account status bit flags + REMOVE_REQUESTED=0x02, //user is requesting disassociation + USER_REKEYED =0x04 // set until we've reported this to the server +}; + +// SqrlHandler +typedef enum { + NO_HANDLER, + SQ_OPENSSL, + SQ_MBEDTLS +} SQ_HANDLER; + +enum { + HANDLER_NAME_SIZ=16, // 15+1 for "MBedTLS", "OpenSSL" or other handlers in .sspapi.cfg + SQ_IP_LEN =sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255"), // 45, + SQ_PORT_LEN =sizeof("65535"), // 5, + + // For the SSP API only, x=n is restricted to 1 digit (0-9) + SQ_EXT_LEN =sizeof("9"), + + SQ_MAX_URL =256, + SQ_MAX_PATH =260, +}; + +typedef struct CRITICAL_SECTION_T { + pthread_mutex_t Lock; + int count; +} CRITICAL_SECTION; + +typedef struct HTTP_STATUS_LOOKUP_T { + int Status; + char *pStatus; +} HTTP_STATUS_LOOKUP; + +typedef enum HTTP_STATUS_T { + HTTP_OK, + HTTP_FOUND, + HTTP_BAD_REQUEST, + HTTP_NOT_FOUND, + HTTP_GONE +} HTTP_STATUS; + +typedef struct QUEUE_OBJECT_T { + struct QUEUE_OBJECT_T *pPriorObject; // non-null pointer to prior object + struct QUEUE_OBJECT_T *pNextObject; // non-null pointer to next object + union { + SQ_DWORD TimeStamp; // system time of last activity (sec.) + SQ_DWORD DataPtr; + SQ_DWORD ObjectData1; + }; + union { + SQ_DWORD ObjectTag; // a 32-bit object association + SQ_DWORD DataLen; + SQ_DWORD ObjectData2; + }; +} QUEUE_OBJECT; + +typedef struct QUEUE_T { + QUEUE_OBJECT *pFirstInQueue; // pointer to next object to be removed + QUEUE_OBJECT *pLastInQueue; // pointer to last object added + SQ_DWORD ObjectCount; // count of objects in queue + CRITICAL_SECTION CriticalSection; +} QUEUE; + +typedef struct PENDING_AUTHS_T { + QUEUE_OBJECT QueueObject; // GRC's standard QUEUE management obj + SQ_CHAR aBrowserNut[12]; // the initial 12-character nut nonce + SQ_CHAR aProtocolNut[12]; // successive 12-character nut nonces + SQ_CHAR szSqrlPublicKey[44]; // the user's valid SQRL ID + SQ_CHAR szInvitation[24]; // an invitation pending on this session + SQ_CHAR aRequestIP[16]; // the requestor's IPv6 IP + SQ_CHAR aCPSNonce[24]; // the 24-character CPS nonce + SQ_BYTE aTransactionMAC1[32]; // HMAC256 hash with "&can=..." appended + SQ_BYTE aTransactionMAC2[32]; // HMAC256 hash without "&can=..." + SQ_DWORD OptionsValue; // the SQRL client's 'opt' value + SQ_CHAR szPathExtension[7+1]; // null string or x=n& from /nut.sqrl? param + SQ_CHAR *pszNextPageURL; // a global alloc containing the URL + SQ_CHAR *pszLoginPageURL ; // a global alloc with the requesting URL +} PENDING_AUTHS; + +typedef struct HEADER_ITEM_T { + char *pKey; + char *pVal; +} HEADER_ITEM; + +enum { + MAX_HEADERS=16 +}; + +// SSP-API Configuration File +extern const char *pszCfgFile; + +typedef struct CFG_INFO_T { + const char *pszName; + const char *pszVariable; + const int Length; // string length for char sz[Length+1] +} CFG_INFO; + +extern CFG_INFO aCfgInfo[]; + +typedef struct CFG_ITEM_T{ + char *pszValue; + char *pComments; + int NumComments; +} CFG_ITEM; + +extern int NumCfgItems; + +/* +=============================================================================== + CLIENT TO SERVER + A pointer to an instance of this structure is passed to "ParseClientQuery" by + "HandleClientQuery". "ParseClientQuery" parses and examines every aspect of + the client's SQRL protocol query. It sets flags & verifies client signatures. +------------------------------------------------------------------------------- + This structure holds the received and parsed query parameters. +---------------------------------------------------------------------------- +*/ +typedef struct CLIENT_TO_SERVER_T { + SQ_DWORD DataPresent; // flags for data that's valid + SQ_DWORD SignaturesValid; // flags for valid signatures + SQ_CHAR *pszVer; // pointer to the returned ver= string + SQ_DWORD cmd; // request command bit flags + SQ_DWORD opt; // request options bit flags + SQ_CHAR nut[12]; // the 12-charater nut nonce + SQ_BYTE idk[32]; + SQ_BYTE pidk[32]; + SQ_BYTE suk[32]; + SQ_BYTE vuk[32]; + SQ_BYTE ids[SIGNATURE_LEN]; + SQ_BYTE pids[SIGNATURE_LEN]; + SQ_BYTE urs[SIGNATURE_LEN]; + SQ_VOID *pSigningBuf; // pointer to aloocated signature buffer + SQ_DWORD SigningBufLen; // length of the signature buffer +} CLIENT_TO_SERVER; + +/* +=============================================================================== + SQRL ASSOCIATIONS +------------------------------------------------------------------------------- + This is the database template for managing our SQRL ID -to- Account mapping. + It is keyed by its first and second records: the 44-character szSqrlPublicKey + and the web server's account as an ASCII string up to 64 characters. It maps + the user's SQRL ID to the web server's internal account and holds SQRL keys + and other management data. To support Managed Shared Access, it also provides + a szUserHandle to allow managers to know whose SQRL ID this is and a szStatus + string for general purpose management needs. +------------------------------------------------------------------------------- +*/ +typedef struct ASSOC_REC_DATA_T { + SQ_CHAR szAccount [68]; // the webserver's user account + SQ_CHAR szUserHandle [68]; // a friendly username for mgmt + SQ_CHAR szStatus [68]; // undefined server data + + SQ_BYTE aSqrlPublicIdentity [32]; // 32-byte SQRL public key + SQ_BYTE aSqrlServerUnlockKey [32]; // the DH IDLock data + SQ_BYTE aSqrlVerifyUnlockKey [32]; // " " + SQ_QWORD SqrlLastActivityDate; // used to purge unlinked entries + SQ_DWORD SqrlOptionFlags; // auth disabled, maybe others +} ASSOC_REC_DATA; + +typedef struct SQRL_ASSOCIATIONS_T { + SQ_CHAR szSqrlUser[USER_ID_FIELD_SIZ]; // for 12-character static SQRL user + ASSOC_REC_DATA AssocRecData; +} SQRL_ASSOCIATIONS; + +/* +=============================================================================== + SUPERSEDED IDENTITIES +------------------------------------------------------------------------------- + This is the database template used for logging all retired SQRL identities + the SSPAPI has ever encountered. EVERY "Previous" ID it encounters is added + to this database which is indexed on the 32-byte PreviousID. If any attempt + is ever made to present one of these retired identities as a CurrentID, the + operation is immediately failed with a TIF error return having its 0x200 bit. +------------------------------------------------------------------------------- +*/ +typedef struct SUPERSEDED_IDENTITIES_T { + SQ_BYTE aSupersededIdentity [32]; // 32-byte SQRL public key +} SUPERSEDED_IDENTITIES; + +/* +=============================================================================== + QUERY PARAMS +------------------------------------------------------------------------------- + The Add and Remove queries may provide all or some of the parameters pointed + to by this structure. This structure is populated by "ParseQueryParams". +------------------------------------------------------------------------------- +*/ +typedef struct QUERY_PARAMS_T { + SQ_CHAR *pszSqrlUser; + SQ_CHAR *pszAccount; + SQ_CHAR *pszUserHandle; + SQ_CHAR *pszStatus; + SQ_CHAR *pszInvite; +} QUERY_PARAMS; + +// An element of ClientTokens[] +typedef struct CLIENT_TOKEN_T { + char *pName; + SQ_DWORD BitMask; +} CLIENT_TOKEN; + +// An element of QueryTokens[] +typedef struct QUERY_TOKEN_T { + char *pName; + SQ_DWORD BitMask; +} QUERY_TOKEN; + +// An element of CommandTable[] or OptionsTable[] +typedef struct CMD_OPT_TABLE_T { + SQ_CHAR *pszName; + SQ_DWORD FlagBit; +} CMD_OPT_TABLE; + +//[ +extern CRITICAL_SECTION DebugCriticalSection; +extern char *pStack[]; +extern int StackNdx; +//] +extern CRITICAL_SECTION IncDataCriticalSection; + +extern QUEUE PendingAuthsQueue; +extern SQ_BOOL SqrlApiRunning; + +extern const HTTP_STATUS_LOOKUP HttpStatusLookup[]; + +extern const char *pszNull; +extern const char *pszNutEquals; +extern const char *pszUrlPrefix; +extern const char *pszPathPrefix; +extern const char *pszNutAndCanLinkFormat; +extern const char *pszQRcodeFormat; +extern const char *pszSQlinkFormat; +extern const char *pszHttpResponseHeaderFormat; +extern const char *pszHttpReplyHeaderFormat; +extern const char *pszHttpImageHeaderFormat; +extern const char *pszUserIdWithAccount; +extern const char *pszUserIdWithNoAccount; +extern const char *pszBlockedPrivateQuery; +extern const char *pszEnumerationFormat; +extern const char *pszQueryTokenList[]; + +extern const char *pszPathPrefix; +extern const char *pszSqrlOnly; +extern const char *pszHardLock; +extern const char *pszDisabled; +extern const char *pszRemove; +extern const char *pszRekeyed; +extern const char *pszComma; + +extern SQ_CHAR szMonotonicCounter[]; + +extern const SQ_CHAR szHandlerName[]; +extern const SQ_CHAR szCertFilename[]; +extern const SQ_CHAR szKeyFilename[]; +extern const SQ_CHAR szListenIp[]; +extern const SQ_CHAR szListenPort[]; +extern const SQ_CHAR szPrivateAccessIp[]; +extern const SQ_CHAR szSystemKey[]; +extern const SQ_CHAR szDatabaseKey[]; +extern const SQ_CHAR szTransactionLogging[]; +extern const SQ_CHAR szPublicAuthDomain[]; +extern const SQ_CHAR szWebServerAuthUrlArray[][SQ_MAX_URL]; + +extern const SQ_HANDLER nHandlerName; +extern const SQ_CHAR szListenUrl[]; +extern const SQ_BYTE aSystemKey[]; +extern const SQ_BOOL bEnableTransactionLogging; + +extern const CLIENT_TOKEN ClientTokens[]; +extern const int NumClientTokens; +extern const QUERY_TOKEN QueryTokens[]; +extern const int NumQueryTokens; +extern const CMD_OPT_TABLE CommandTable[]; +extern const int NumCommandItems; +extern const CMD_OPT_TABLE OptionTable[]; +extern const int NumOptionItems; + +extern const SQ_CHAR *pszSqrlReplyFormat; + +// Functions + +// base64url.c +int GetBase64urlEncodedSize(int len); +int GetBase64urlDecodedSize(int len); +int Base64urlEncode(const unsigned char *in, int len, char *out, int siz); +int Base64urlDecode(const char *in, int len, unsigned char *out, int siz); +SQ_DWORD SqrlCvrtToBase64(SQ_CHAR *pOut, SQ_DWORD SizOut, const SQ_BYTE *pIn, SQ_DWORD LenIn); +SQ_DWORD SqrlCvrtFromBase64(SQ_BYTE *pOut, SQ_DWORD SizeOut, const SQ_CHAR *pIn, SQ_DWORD LengthIn); +SQ_DWORD CvrtToBase64String(SQ_CHAR *pOut, SQ_DWORD SizOut, const SQ_BYTE *pIn, SQ_DWORD LenIn); +void DecodeBase64szAndStore(SQ_BYTE **ppszDecoded, const SQ_CHAR *pBase64sz); + +// browser.c +SQ_CHAR *GetStringInGlobalAlloc(SQ_CHAR *pString); +void GetQueryParamNut(SQ_CHAR *pszNutBuffer, SQRL_CONTROL_BLOCK *pSCB); +void SetLoginPageUrl(PENDING_AUTHS *pPendingAuth, SQRL_CONTROL_BLOCK *pSCB); +SQ_VOID SubmitCpsAuth(SQRL_CONTROL_BLOCK *pSCB); +void TriggerNonCpsAuth(PENDING_AUTHS *pPendingAuth, SQRL_CONTROL_BLOCK *pSCB); +SQ_VOID GetSessionNut(SQRL_CONTROL_BLOCK *pSCB); +SQ_VOID GetQRcode(SQRL_CONTROL_BLOCK *pSCB); +SQ_VOID GetNextPage(SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE ListSupersededIDs(SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE ListPendingAuths(SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE ListDatabase(SQRL_CONTROL_BLOCK *pSCB); +SQ_VOID SetPathExtensionString(SQ_CHAR *pszPathExtension, SQRL_CONTROL_BLOCK *pSCB); +PENDING_AUTHS *PrepPendingAuthObject(SQRL_CONTROL_BLOCK *pSCB); + +// client.c +void CommandOptionParser(SQ_DWORD *pResultFlags, const CMD_OPT_TABLE ArgsTable[], int NumItems, SQ_CHAR *pszArgList); +SQ_RCODE ParseClientQuery (CLIENT_TO_SERVER *pParams, PENDING_AUTHS **ppPendingAuth, SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE SanityCheckAsciiKey(SQ_CHAR *pKey); +SQ_CHAR *NullTerminateString(SQ_CHAR *ptr); +SQ_RCODE HandleClientQuery(SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE SendResponse(SQRL_CONTROL_BLOCK *pSCB, CLIENT_TO_SERVER *pQueryParams, SQ_DWORD TransInfo, SQRL_ASSOCIATIONS *pSqrlAssoc, PENDING_AUTHS *pPendingAuth); +void UpdateSqrlAssociationRecord(SQRL_ASSOCIATIONS *pSqrlAssoc, CLIENT_TO_SERVER *pQueryParams); + +// configdata.c +SQ_RCODE ReadCfgFile(CFG_ITEM **ppCfgItems, char **ppData); +SQ_RCODE WriteCfgFile(CFG_ITEM *pCfgItems, char *pData); +int HexToNybble(int h); +int NybbleToHex(int n); +SQ_RCODE CreateFile(FILE **ppFile, const char *pFilename, char *pMode); +SQ_RCODE OpenFile(FILE **ppFile, const char *pFilename, char *pMode); +SQ_RCODE CloseFile(FILE **ppFile); +SQ_RCODE InitSqrlCfgData(); +SQ_RCODE Get64BitCounter(SQ_BYTE *pCounterByteArray); +SQ_RCODE Set64BitCounter(SQ_BYTE *pCounterByteArray); +SQ_RCODE SetCfgItem(int ItemIndex, char *pszItemValue); + +// criticalsection.c +int InitializeCriticalSection(CRITICAL_SECTION *pLock); +int DeleteCriticalSection(CRITICAL_SECTION *pLock); +SQ_BOOL EnterCriticalSection(CRITICAL_SECTION *pLock); +SQ_BOOL LeaveCriticalSection(CRITICAL_SECTION *pLock); + +// crypto.c +SQ_RCODE HMAC256(SQ_BYTE *pHashOut, SQ_BYTE *pSourceToHMAC, SQ_DWORD Len, const SQ_BYTE *pHashKey); +SQ_RCODE SqrlVerifySig(SQ_BYTE *pMsg, SQ_DWORD uMsgLen, SQ_BYTE *pSig, SQ_BYTE *pPubKey); + +// database.c +void SweepNightlyAbandonedInvitations(); +void SweepNightlyAbandonedAuthentications(); +void *DatabaseSweepThread(SQ_VOID *Dummy); +void TerminateDatabaseSweeper(); +void GetDatabasePathname(SQ_CHAR *pszDatabasePath); +void SyncAllBDB(); +void DeleteSqrlDatabaseFiles(); +SQ_RCODE OpenSqrlDatabaseFiles(); +SQ_RCODE CloseBerkeleyDBs(); +SQ_RCODE StoreSqrlRecord(SQRL_ASSOCIATIONS *pSqrlDataRecord); +SQ_RCODE GetRecordByUserID(SQRL_ASSOCIATIONS *pSqrlRecord, SQ_CHAR *pszUserId); +SQ_RCODE GetRecordBySqrlID(SQRL_ASSOCIATIONS *pSqrlRecord, SQ_CHAR *pszSqrlId); +SQ_RCODE GetRecordBySqrlKey(SQRL_ASSOCIATIONS *pSqrlRecord, SQ_BYTE *p_idk); +SQ_RCODE GetRecordByInvitation(SQRL_ASSOCIATIONS *pSqrlRecord, SQ_CHAR *pszInvitation); +SQ_RCODE DeleteSqrlRecord(SQRL_ASSOCIATIONS *pSqrlAssocRec); +SQ_RCODE LogSupersededID(SUPERSEDED_IDENTITIES *pSupersededIdentity); +SQ_RCODE CheckForSupersededID(SUPERSEDED_IDENTITIES *pSupersededIdentity); +SQ_CHAR *GetListOfAssociations(SQ_CHAR *pszAccount); +void UpdateByAccount(QUERY_PARAMS *pQueryParams, SQ_BOOL Remove); +char *GetBerkeleyMainDatabase(); +char *GetSupersededIDs(); + +// global.c +int Utf8Len(char *pszUtf8); + +// handler.c +SQ_RCODE InitSqrlHandler(); +SQ_RCODE WriteResponseHeaders(SQRL_CONTROL_BLOCK *pSCB, HTTP_STATUS Status, SQ_CHAR *pszHeaders, SQ_DWORD DataLen); +SQ_RCODE WriteClient(SQRL_CONTROL_BLOCK *pSCB, SQ_BYTE *pData, SQ_DWORD *pDataLen); +SQ_RCODE ProcessHeaders(SQRL_CONTROL_BLOCK *pSCB, char *pHeaders); + +// handler-openssl.c +SQ_RCODE InitSqrlHandlerOpenSSL(); +char *GetHeadersBufferOpenSSL(); +SQ_RCODE WriteClientOpenSSL(SQRL_CONTROL_BLOCK *pSCB, SQ_BYTE *pData, SQ_DWORD *pDataLen); + +// handler-mbedtls.c +SQ_RCODE InitSqrlHandlerMBedTLS(); +char *GetHeadersBufferMBedTLS(); +SQ_RCODE WriteClientMBedTLS(SQRL_CONTROL_BLOCK *pSCB, SQ_BYTE *pData, SQ_DWORD *pDataLen); + +// pendingauths.c +void DeletePendingAuthAllocs(void *pObject); +void DeletePendingAuthObject(void *pObject); +PENDING_AUTHS *LookupByNut(PENDING_AUTHS *pPendingAuth, SQ_CHAR *pNut, SQ_BOOL bUpdateObject, SQ_BOOL bProtocolNut, SQRL_CONTROL_BLOCK *pSCB); +PENDING_AUTHS *LookupByCPS(PENDING_AUTHS *pPendingAuth, SQ_VOID *pCPSnonce, SQ_BOOL bUpdateObject); +void SetInitialAuthMacs(PENDING_AUTHS *pPendingAuth, SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE CreateQueue(QUEUE *pQueue); +SQ_RCODE DeleteQueue(QUEUE *pQueue, SQ_PROCPTR pDestructor); +SQ_RCODE Enqueue(QUEUE *pQueue, QUEUE_OBJECT *pNewObject); +QUEUE_OBJECT *Dequeue(QUEUE *pQueue); +SQ_RCODE DequeueObject(QUEUE *pQueue, QUEUE_OBJECT *pQueueObject); +char *GetPendingAuths(); + +// qrcode.c +void SendStringAsQRcodeImage(SQRL_CONTROL_BLOCK *pSCB, SQ_CHAR *pszStringToConvert); + +// response.c +SQ_RCODE SendSqrlReply(SQRL_CONTROL_BLOCK *pSCB, SQ_BYTE *pReplyData, SQ_DWORD ReplyLength, SQ_RCODE Success); +SQ_RCODE ReturnStringToCaller(SQ_CHAR *pszResponseString, SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE ReturnImageToClient (SQRL_CONTROL_BLOCK *pSCB, SQ_BYTE *pImageData, SQ_DWORD ImageLength); +SQ_RCODE WriteToClient(SQRL_CONTROL_BLOCK* pSCB, SQ_BYTE *pBuffer, SQ_DWORD OptionalLength); +SQ_RCODE Return404NotFound(SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE Return410Gone(SQRL_CONTROL_BLOCK *pSCB); + +// server.c +void DeEscapeFormData(SQ_CHAR *pszBufferToDeEscape); +void ParseQueryParams(QUERY_PARAMS *pQueryParams, SQ_CHAR *pszQueryString); +void VerifyValidInvitation(SQ_BYTE * pSqrlPublicIdentity); +SQ_RCODE ReturnListOfAssociations(SQ_CHAR *pszAccount, SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE UpdateBySqrlUser(QUERY_PARAMS *pQueryParams); +SQ_RCODE AddAssociation(SQRL_CONTROL_BLOCK *pSCB); +void RemoveAssociation(SQRL_CONTROL_BLOCK *pSCB); +void ListAssociations(SQRL_CONTROL_BLOCK *pSCB); +void InviteAssociation(SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE AcceptInvitation(SQRL_CONTROL_BLOCK *pSCB); + +// sspapi.c +void InitResponse(SQRL_RESPONSE *pResponse); +void FreeResponse(SQRL_RESPONSE *pResponse); +void HttpExtensionProc (SQRL_CONTROL_BLOCK *pSCB); +void GetUrlEncodedReferrer(SQ_CHAR *pszEncodedPageURL, SQ_DWORD EncBufLen, SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE InitSqrlSystem(); +SQ_RCODE ShutDownSqrlSystem(); + +// utils.c +void LogTheQueryAndReply(SQ_CHAR *pszMessage, SQRL_CONTROL_BLOCK *pSCB); +void *GlobalAlloc(SQ_DWORD NumBytes); +void GlobalFree(void **ppGlobalAllocation); +SQ_RCODE CheckLocalhostCaller(SQRL_CONTROL_BLOCK *pSCB); +void SQ_GetSystemTimeAsFileTime(SQ_QWORD *pFileTime); +SQ_DWORD SQ_GetFileTimeAgeInMinutes(SQ_QWORD *pSqrlLastActivityDate, SQ_QWORD *pCurrentTime); +SQ_DWORD GetSystemOneSecondTime(); +SQ_RCODE GetNextMonotonicCounterValue(SQ_BYTE *pNextValue); +void GetUnpredictable64bits(SQ_BYTE *p64bitBuffer); +void GetUnique12charNut(SQ_CHAR *pszBase64Buffer, SQ_BOOL NullTerm); +void GetUnique20digitToken(SQ_CHAR *p20CharBuffer, SQ_BOOL NullTerm); +void IPv4StringToAddress(char *pIPaddress, void *pBuffer, unsigned int *pBufferLength); +void IPv6StringToAddress(char *pIPaddress, void *pBuffer, unsigned int *pBufferLength); +void ObtainClientConnectionIP(void *pIPbuffer, SQRL_CONTROL_BLOCK *pSCB); +SQ_RCODE VerifyPrivateQuery(SQRL_CONTROL_BLOCK *pSCB); +void UrlEncode(SQ_CHAR *pDstBuffer, SQ_CHAR *pSrcBuffer); +void PlaceCpsUrlIntoBuffer(SQ_CHAR *pBuffer, PENDING_AUTHS *pPendingAuth); + +#endif diff --git a/SSP-API-Source/handler-mbedtls.c b/SSP-API-Source/handler-mbedtls.c new file mode 100644 index 0000000..7c1daa4 --- /dev/null +++ b/SSP-API-Source/handler-mbedtls.c @@ -0,0 +1,650 @@ + +// handler_mb MBedTLS server (derived from MBedTLS ssl_pthread_server.c) + +#include "global.h" + +#if defined NO_MBEDTLS + +// None of the following code is used + +#else + +// Options required for this SSP_API +#define MBEDTLS_PEM_PARSE +#define MBEDTLS_THREADING_C +#define MBEDTLS_THREADING_PTHREAD + +// This is NOT defined +#if defined(MBEDTLS_CONFIG_FILE) +#include MBEDTLS_CONFIG_FILE +#else +#include "mbedtls/config.h" +#endif + +// This IS defined +#if defined(MBEDTLS_PLATFORM_C) +#include "mbedtls/platform.h" +#else +#include +#include +#define mbedtls_fprintf fprintf +#define mbedtls_printf printf +#define mbedtls_snprintf snprintf +#define mbedtls_exit exit +#define MBEDTLS_EXIT_SUCCESS EXIT_SUCCESS +#define MBEDTLS_EXIT_FAILURE EXIT_FAILURE +#endif + +#include +#include + +#include "mbedtls/entropy.h" +#include "mbedtls/ctr_drbg.h" +#include "mbedtls/certs.h" +#include "mbedtls/x509.h" +#include "mbedtls/ssl.h" +#include "mbedtls/net_sockets.h" +#include "mbedtls/error.h" + +// This IS defined +#if defined(MBEDTLS_SSL_CACHE_C) +#include "mbedtls/ssl_cache.h" +#endif + +// This is NOT defined +#if defined(MBEDTLS_CHECK_PARAMS) +#include "mbedtls/platform_util.h" +void mbedtls_param_failed(const char *failure_condition, const char *file, int line) { + mbedtls_printf("%s:%i: Input param failed - %s\n", file, line, failure_condition); + mbedtls_exit( MBEDTLS_EXIT_FAILURE ); +} +#endif + +//[fpf +// MBedTLS specific data we need to carry in the SQRL_CONTROL_BLOCK scb +typedef struct MBEDTLS_STRUCT_T { + long int thread_id; + mbedtls_ssl_context ssl; + char szHeaders[1024]; +} MBEDTLS_STRUCT; + +static SQ_BOOL bFinished; + +#define DEBUG_LEVEL 0 +#define MAX_NUM_THREADS 1024 +mbedtls_threading_mutex_t debug_mutex; + +static void my_mutexed_debug(void *ctx, int level, const char *file, int line, const char *str ) { + long int thread_id=(long int)pthread_self(); + mbedtls_mutex_lock(&debug_mutex); +//? ((void)level); + mbedtls_fprintf((FILE *)ctx, "%s:%04d: [ #%ld ] %s", file, line, thread_id, str ); + fflush((FILE *)ctx); + mbedtls_mutex_unlock( &debug_mutex ); +} + +typedef struct { + mbedtls_net_context client_fd; + int thread_complete; + const mbedtls_ssl_config *config; + char szClientIp[SQ_IP_LEN+1]; +} thread_info_t; + +typedef struct { + int active; + thread_info_t data; + pthread_t thread; +} pthread_info_t; + +static thread_info_t base_info; +static pthread_info_t threads[MAX_NUM_THREADS]; + +static void *handle_ssl_connection( void *data ) { + BEG("handle_ssl_connection()"); + int ret, len; + thread_info_t *thread_info=(thread_info_t *)data; + mbedtls_net_context *client_fd=&thread_info->client_fd; + long int thread_id=(long int)pthread_self(); + char buf[1024]; + mbedtls_ssl_context ssl; + + // Make sure memory references are valid + mbedtls_ssl_init(&ssl); + mbedtls_printf("[# %08lx ] Setting up SSL/TLS data\n", thread_id ); + + // * 4. Get the SSL context ready + + if((ret=mbedtls_ssl_setup(&ssl, thread_info->config))!=0) { + mbedtls_printf("[# %08lx ] failed: mbedtls_ssl_setup returned -0x%04x\n", thread_id, -ret); + goto thread_exit; + } + mbedtls_ssl_set_bio(&ssl, client_fd, mbedtls_net_send, mbedtls_net_recv, NULL); + + // * 5. Handshake + + mbedtls_printf("[# %08lx ] Performing the SSL/TLS handshake\n", thread_id); + while((ret=mbedtls_ssl_handshake(&ssl))!=0) { + if(ret!=MBEDTLS_ERR_SSL_WANT_READ && ret!=MBEDTLS_ERR_SSL_WANT_WRITE) { + mbedtls_printf("[# %08lx ] failed: mbedtls_ssl_handshake returned -0x%04x\n", thread_id, -ret); + goto thread_exit; + } + } + mbedtls_printf("[# %08lx ] ok\n", thread_id); + + // * 6. Read the HTTP Request + + mbedtls_printf("[# %08lx ] < Read from client\n", thread_id); + +//[fpf +//. is this right for multi-threading? + SQRL_CONTROL_BLOCK scb; + MBEDTLS_STRUCT mbedtls; + + memset(&scb, 0, sizeof(SQRL_CONTROL_BLOCK)); + memset(&mbedtls, 0, sizeof(MBEDTLS_STRUCT)); + mbedtls.thread_id=thread_id; + mbedtls.ssl=ssl; +//] + do { + len=sizeof(buf)-1; + memset(buf, 0, sizeof(buf)); + ret=mbedtls_ssl_read(&ssl, (unsigned char *)buf, len); + + if(ret==MBEDTLS_ERR_SSL_WANT_READ || ret==MBEDTLS_ERR_SSL_WANT_WRITE) { + continue; + } + if(ret<=0) { + switch(ret) { + case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY: + mbedtls_printf("[# %08lx ] connection was closed gracefully\n", thread_id); + goto thread_exit; + + case MBEDTLS_ERR_NET_CONN_RESET: + mbedtls_printf("[# %08lx ] connection was reset by peer\n", thread_id); + goto thread_exit; + + default: + mbedtls_printf("[# %08lx ] mbedtls_ssl_read returned -0x%04x\n", thread_id, -ret); + goto thread_exit; + } + } + len=ret; + mbedtls_printf("[# %08lx ] %d bytes read\n=====\n%s\n=====\n", thread_id, len, (char *) buf); + + if(ret>0) { +//[ +printf("\r\n//[\r\n"); +//] + // Request-Line = Method Request-URI HTTP-Version + char *pBuf=buf; + char *pEnd=pBuf+len; + + // Get the Method + while(*pBuf==' ' || *pBuf=='\r' || *pBuf=='\n') pBuf++; + if(pBuf ) + while(memcmp(pBuf, "\r\n\r\n", 4)!=0) pBuf++; + pBuf+=2; // skip past the first + if(pBuf=pEnd) { + // There is no data + pDataBeg=pEnd; + } else { + pDataBeg=pBuf; + } + char *pDataEnd=pEnd; +/// can we make this '\0' ? +printf("HTTP DataLen: %d\r\n", (int)(pDataEnd-pDataBeg)); + + // Get the data length + scb.DataLen=pDataEnd-pDataBeg; +printf("SCB.DataLen %d\r\n", scb.DataLen); + + // Get the data + scb.lpData=pDataBeg; +printf("HTTP Data: %s\r\n", scb.lpData); + + strcpy(scb.szServerPort, szListenPort); +printf("SCB.lpszServerPort: %s\r\n", scb.szServerPort); + +printf("SCB.lpszHttpHost: %s\r\n", scb.lpszHttpHost); + +printf("SCB.lpszHttpReferrer: %s\r\n", scb.lpszHttpReferrer); + + scb.lpszRemoteAddr=thread_info->szClientIp; +printf("SCB.lpszRemoteAddr: %s\r\n", scb.lpszRemoteAddr); + +printf("SCB.lpszHttpOrigin: %s\r\n", scb.lpszHttpOrigin); + + scb.lpHandlerStruct=&mbedtls; + scb.pResponse=NULL; +printf("\r\n//]\r\n"); +//] + break; + } + } + while( 1 ); +//[fpf + // Parse and process the query + EnterCriticalSection(&DebugCriticalSection); + + LOG("Parse and Process the Query"); + + LOG(" Method: %s", scb.lpszMethod); + LOG("PathInfo: %s", scb.lpszPathInfo); + LOG(" Query: %s", scb.lpszQueryString); + +//[ FOR TESTING + if(strcmp(scb.lpszPathInfo, "/end.sqrl")==0) { + bFinished=SQ_TRUE; + } + else if(strcmp(scb.lpszPathInfo, "/del.sqrl")==0) { + CloseBerkeleyDBs(); + DeleteSqrlDatabaseFiles(); + bFinished=SQ_TRUE; + } + else +//] + HttpExtensionProc(&scb); + + LOG(""); + LeaveCriticalSection(&DebugCriticalSection); +//] + ret = 0; + +thread_exit: + +// This IS defined +#if defined(MBEDTLS_ERROR_C) + if(ret!=0 ) { + char error_buf[100]; + mbedtls_strerror(ret, error_buf, 100 ); + mbedtls_printf("[# %08lx ] Last error was: -0x%04x - %s\n\n", thread_id, -ret, error_buf ); + } +#endif + mbedtls_net_free(client_fd); + mbedtls_ssl_free(&ssl); + + thread_info->thread_complete=1; + + END(); + return NULL; +} + +static int thread_create( mbedtls_net_context *client_fd, char *pszClientIp ) { + BEG("thread_create()"); + int ret, i; + + // * Find in-active or finished thread slot + for(i=0; ilpHandlerStruct)->szHeaders; + } + +SQ_RCODE WriteClientMBedTLS(SQRL_CONTROL_BLOCK *pSCB, SQ_BYTE *pData, SQ_DWORD *pDataLen) { + BEG("WriteClientMBedTLS()"); + LOG("Data:"); + LOG("Beg..."); + LOG("[]", pData, *pDataLen); + LOG("...End"); + + SQ_RCODE rc=SQ_PASS; + + if(pSCB->pResponse!=NULL) { + pSCB->pResponse->pData=GlobalAlloc(*pDataLen); + memcpy(pSCB->pResponse->pData, pData, *pDataLen); + pSCB->pResponse->DataLen=*pDataLen; + } + else { +#if defined NO_MBEDTLS + LOG("NO_MBEDTLS is #defined"); +#else + long int thread_id=((MBEDTLS_STRUCT*)(pSCB->lpHandlerStruct))->thread_id; + mbedtls_ssl_context ssl=((MBEDTLS_STRUCT*)(pSCB->lpHandlerStruct))->ssl; + char *pszHeaders=((MBEDTLS_STRUCT*)(pSCB->lpHandlerStruct))->szHeaders; + + mbedtls_printf("[# %08lx ] > Write to client:\n", thread_id); + + int HeadersLen=strlen(pszHeaders); + int len=HeadersLen+*pDataLen; + int ret; + + unsigned char *pBuffer=(unsigned char *)GlobalAlloc(len); + + memcpy(pBuffer, pszHeaders, HeadersLen); + memcpy(pBuffer+HeadersLen, pData, *pDataLen); + + while((ret=mbedtls_ssl_write(&ssl, pBuffer, len ))<=0) { + if(ret==MBEDTLS_ERR_NET_CONN_RESET) { + mbedtls_printf("[# %08lx ] failed: peer closed the connection\n", thread_id); + goto thread_exit; + } + + if(ret!=MBEDTLS_ERR_SSL_WANT_READ && ret!=MBEDTLS_ERR_SSL_WANT_WRITE) { + mbedtls_printf("[# %08lx ] failed: mbedtls_ssl_write returned -0x%04x\n", thread_id, ret); + goto thread_exit; + } + } + + len=ret; + mbedtls_printf("[# %08lx ] %d bytes written\n=====\n%s\n=====\n", thread_id, len, (char *)pBuffer); + + /// do we close the connection if we have a "keep-alive" header? + + mbedtls_printf("[# %08lx ] . Closing the connection...", thread_id); + + while((ret=mbedtls_ssl_close_notify(&ssl))<0) { + if(ret!=MBEDTLS_ERR_SSL_WANT_READ && ret!=MBEDTLS_ERR_SSL_WANT_WRITE) { + mbedtls_printf("[# %08lx ] failed: mbedtls_ssl_close_notify returned -0x%04x\n", thread_id, ret); + goto thread_exit; + } + } + mbedtls_printf(" ok\n"); + +thread_exit: + GlobalFree((void **)&pBuffer); + rc=(ret==0? SQ_PASS: SQ_FAIL); +#endif + } + + END(); + return rc; +} diff --git a/SSP-API-Source/handler-openssl.c b/SSP-API-Source/handler-openssl.c new file mode 100644 index 0000000..9b63f25 --- /dev/null +++ b/SSP-API-Source/handler-openssl.c @@ -0,0 +1,382 @@ + +// handler using Open SSL + +#include "global.h" + +// compile with libraries libssl and libcrypto + +#include // for close() +#include +#include +#include +#include + +typedef struct OPENSSL_STRUCT_T { + long int thread_id; + SSL *ssl; + char szClientIp[1024]; + char szHeaders[1024]; +} OPENSSL_STRUCT; + + +static SQ_BOOL bFinished; + +// Once initialized, these are constant +//[not used] const char szListenProtocol[]="https://"; +//[in configdata.c] const char szListenIp[SQ_IP_LEN+1]; // "ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255" +//[in configdata.c] const char szListenPort[SQ_PORT_LEN+1]; // "65565" + +//[ +// needs modifying to accept AF_INET6 ip address too +//] +int create_socket() { + int s; + struct sockaddr_in addr; + + addr.sin_family = AF_INET; + addr.sin_port = htons(strtol(szListenPort, NULL, 10)); + inet_pton(AF_INET, szListenIp, &addr.sin_addr.s_addr); + + s = socket(AF_INET, SOCK_STREAM, 0); + if (s < 0) { + perror("Unable to create socket"); + exit(EXIT_FAILURE); + } +///[ +// https://stackoverflow.com/questions/4163268/how-to-reuse-a-bound-port-with-openssl-api +//setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes)); +///] + if (bind(s, (struct sockaddr*)&addr, sizeof(addr)) < 0) { + perror("Unable to bind"); + exit(EXIT_FAILURE); + } + if (listen(s, 1) < 0) { + perror("Unable to listen"); + exit(EXIT_FAILURE); + } + + return s; +} + +void init_openssl() { + SSL_load_error_strings(); + OpenSSL_add_ssl_algorithms(); +} + +void cleanup_openssl() { + EVP_cleanup(); +} + +SSL_CTX *create_context() { + const SSL_METHOD *method; + SSL_CTX *ctx; + + method = SSLv23_server_method(); + + ctx = SSL_CTX_new(method); + if (!ctx) { + perror("Unable to create SSL context"); + ERR_print_errors_fp(stderr); + exit(EXIT_FAILURE); + } + + return ctx; +} + +void configure_context(SSL_CTX *ctx) { + SSL_CTX_set_ecdh_auto(ctx, 1); + + /* Set the key and cert */ + if (SSL_CTX_use_certificate_file(ctx, szCertFilename, SSL_FILETYPE_PEM) <= 0) { + ERR_print_errors_fp(stderr); + exit(EXIT_FAILURE); + } + + if (SSL_CTX_use_PrivateKey_file(ctx, szKeyFilename, SSL_FILETYPE_PEM) <= 0 ) { + ERR_print_errors_fp(stderr); + exit(EXIT_FAILURE); + } +} + +void ParseAndProcessRequest(SSL *ssl, char *pRequest, int Len) { + BEG("ParseAndProcessRequest"); +//[ +//. can we even implement multi-threading in OpenSSL? +long int thread_id=(long int)pthread_self(); +//] + SQRL_CONTROL_BLOCK scb; + OPENSSL_STRUCT openssl; + + memset(&scb, 0, sizeof(SQRL_CONTROL_BLOCK)); + memset(&openssl, 0, sizeof(OPENSSL_STRUCT)); + openssl.thread_id=thread_id; + openssl.ssl=ssl; + + printf("Bytes received: %d\n", Len); + printf("Data: "); + for (int i=0; isin_addr.s_addr), openssl.szClientIp, 1024 ); + printf("iv4: %s\n", openssl.szClientIp); + } else if (peeraddr.sa_family == AF_INET6) { + struct sockaddr_in6 *peeraddr_in=(struct sockaddr_in6 *)&peeraddr; + inet_ntop(AF_INET6, &(peeraddr_in->sin6_addr.s6_addr), openssl.szClientIp, 1024 ); + printf("iv6: %s\n", openssl.szClientIp); + } else { + printf("Unknown socket type passed to worker(): %i\n", peeraddr.sa_family); + } + + // Request-Line = Method Request-URI HTTP-Version + char *pBuf=pRequest; + char *pEnd=pBuf+Len; + + // Get the Method + while(*pBuf==' ' || *pBuf=='\r' || *pBuf=='\n') pBuf++; + if(pBuf ) + while(memcmp(pBuf, "\r\n\r\n", 4)!=0) pBuf++; + pBuf+=2; // skip past the first + if(pBuf=pEnd) { + // There is no data + pDataBeg=pEnd; + } else { + pDataBeg=pBuf; + } + char *pDataEnd=pEnd; +/// can we make this '\0' ? +printf("HTTP DataLen: %d\r\n", (int)(pDataEnd-pDataBeg)); + + // Get the data length + scb.DataLen=pDataEnd-pDataBeg; +printf("SCB.DataLen %d\r\n", scb.DataLen); + + // Get the data + scb.lpData=pDataBeg; +printf("HTTP Data: %s\r\n", scb.lpData); + + strcpy(scb.szServerPort, szListenPort); +printf("SCB.lpszServerPort: %s\r\n", scb.szServerPort); + +printf("SCB.lpszHttpHost: %s\r\n", scb.lpszHttpHost); + +printf("SCB.lpszHttpReferrer: %s\r\n", scb.lpszHttpReferrer); + + scb.lpszRemoteAddr=openssl.szClientIp; +printf("SCB.lpszRemoteAddr: %s\r\n", scb.lpszRemoteAddr); + +printf("SCB.lpszHttpOrigin: %s\r\n", scb.lpszHttpOrigin); + + scb.lpHandlerStruct=&openssl; + scb.pResponse=NULL; +printf("\r\n//]\r\n"); + + EnterCriticalSection(&DebugCriticalSection); + + LOG(" Method: %s", scb.lpszMethod); + LOG("PathInfo: %s", scb.lpszPathInfo); + LOG(" Query: %s", scb.lpszQueryString); + +//[ FOR TESTING + if(strcmp(scb.lpszPathInfo, "/end.sqrl")==0) { + bFinished=SQ_TRUE; + } + else if(strcmp(scb.lpszPathInfo, "/del.sqrl")==0) { + CloseBerkeleyDBs(); + DeleteSqrlDatabaseFiles(); + bFinished=SQ_TRUE; + } + else +//] + HttpExtensionProc(&scb); + + LOG(""); + LeaveCriticalSection(&DebugCriticalSection); +//] + END(); +} + +SQ_RCODE InitSqrlHandlerOpenSSL() { + BEG("InitSqrlHandlerOpenSSL()"); + SQ_RCODE rc=SQ_PASS; + + int sock; + SSL_CTX *ctx; + + init_openssl(); + ctx = create_context(); + + configure_context(ctx); + + sock = create_socket(); + + /* Handle connections */ + + while (bFinished==SQ_FALSE) { + struct sockaddr_in addr; + uint len = sizeof(addr); + SSL *ssl; + + int client = accept(sock, (struct sockaddr*)&addr, &len); +LOG("OpenSSL: accept() client=%d", client); + if (client < 0) { + END(); + return SQ_FAIL; + } + + ssl = SSL_new(ctx); + SSL_set_fd(ssl, client); + + if (SSL_accept(ssl) <= 0) { + ERR_print_errors_fp(stderr); + } + else { + char buf[1024]; + int r = SSL_read(ssl, buf, 1024); + + if(r<=0) { + // Handle the error + switch (r) { + default: + printf("SSL_read returned error code %d", r); + break; + } + } + else { + // Parse and process the request + ParseAndProcessRequest(ssl, buf, r); + } + } + SSL_free(ssl); + close(client); +LOG("openSSL: client closed"); + } + + close(sock); + SSL_CTX_free(ctx); + cleanup_openssl(); + + END(); + return rc; +} + +char *GetHeadersBufferOpenSSL(SQRL_CONTROL_BLOCK *pSCB) { + return ((OPENSSL_STRUCT *)pSCB->lpHandlerStruct)->szHeaders; + } + +SQ_RCODE WriteClientOpenSSL(SQRL_CONTROL_BLOCK *pSCB, SQ_BYTE *pData, SQ_DWORD *pDataLen) { + BEG("WriteClient()"); + LOG("Data:"); + LOG("Beg..."); + LOG("[]", pData, *pDataLen); + LOG("...End"); + + SQ_RCODE rc=SQ_PASS; + + if(pSCB->pResponse!=NULL) { + pSCB->pResponse->pData=GlobalAlloc(*pDataLen); + memcpy(pSCB->pResponse->pData, pData, *pDataLen); + pSCB->pResponse->DataLen=*pDataLen; + } + else { +// long int thread_id=((OPENSSL_STRUCT *)(pSCB->lpHandlerStruct))->thread_id; + SSL *pSSL=((OPENSSL_STRUCT *)(pSCB->lpHandlerStruct))->ssl; + char *pszHeaders=((OPENSSL_STRUCT *)(pSCB->lpHandlerStruct))->szHeaders; + + int HeadersLen=strlen(pszHeaders); + int len=HeadersLen+*pDataLen; + int ret; + + unsigned char *pBuffer=(unsigned char *)GlobalAlloc(len); + + memcpy(pBuffer, pszHeaders, HeadersLen); + memcpy(pBuffer+HeadersLen, pData, *pDataLen); + + ret=SSL_write(pSSL, pBuffer, len); +/// check ret value + + GlobalFree((void **)&pBuffer); + rc=(ret=0? SQ_PASS: SQ_FAIL); + } + + END(); + return rc; +} + diff --git a/SSP-API-Source/handler.c b/SSP-API-Source/handler.c new file mode 100644 index 0000000..901287a --- /dev/null +++ b/SSP-API-Source/handler.c @@ -0,0 +1,118 @@ + +// handler.c + +#include "global.h" + +SQ_RCODE InitSqrlHandler() { + switch(nHandlerName) { + case SQ_OPENSSL: + return InitSqrlHandlerOpenSSL(); + + case SQ_MBEDTLS: + return InitSqrlHandlerMBedTLS(); + + default: + // no handler + return SQ_PASS; + } +} + +SQ_RCODE WriteResponseHeaders(SQRL_CONTROL_BLOCK *pSCB, HTTP_STATUS Status, SQ_CHAR *pszHeaders, SQ_DWORD DataLen) { + BEG("WriteResponseHeaders()"); + LOG("Status: %s", HttpStatusLookup[Status].pStatus); + LOG("Headers:"); + LOG("Beg..."); +//[ + char *pTmp=strcpy(malloc(strlen(pszHeaders)+1), pszHeaders); + char *token=strtok(pTmp, "\r\n"); + while(token!=NULL) { + LOG("%s", token); + token=strtok(NULL, "\r\n"); + } + free(pTmp); +//] + LOG("...End"); + + enum {BufSiz=64}; + char szPreBuffer[BufSiz]; + char szPostBuffer[BufSiz]; + + int len=0; + + len+=sprintf(szPreBuffer, "HTTP/1.0 %s\r\n", HttpStatusLookup[Status].pStatus); + len+=strlen(pszHeaders); + len+=sprintf(szPostBuffer, "content-length: %d\r\n\r\n", DataLen); + + if(pSCB->pResponse!=NULL) { + // Return the headers + pSCB->pResponse->pszHeaders=GlobalAlloc(len+1); + sprintf(pSCB->pResponse->pszHeaders, "%s%s%s", szPreBuffer, pszHeaders, szPostBuffer); + } + else { +#if defined NO_HANDLER + LOG("NO_HANDLER is #defined"); +#else + // Save the headers for WriteClient() + char aDummyBuffer[1024]; + char *pszHandlerHeaders; + switch(nHandlerName) { + case SQ_OPENSSL: + pszHandlerHeaders=GetHeadersBufferOpenSSL(pSCB); + break; + + case SQ_MBEDTLS: + pszHandlerHeaders=GetHeadersBufferMBedTLS(pSCB); + break; + + default: + pszHandlerHeaders=aDummyBuffer; + break; + } + sprintf(pszHandlerHeaders, "%s%s%s", szPreBuffer, pszHeaders, szPostBuffer); +#endif + } + END(); + return SQ_PASS; +} + +SQ_RCODE WriteClient(SQRL_CONTROL_BLOCK *pSCB, SQ_BYTE *pData, SQ_DWORD *pDataLen) { + switch(nHandlerName) { + case SQ_OPENSSL: + return WriteClientOpenSSL(pSCB, pData, pDataLen); + + case SQ_MBEDTLS: + return WriteClientMBedTLS(pSCB, pData, pDataLen); + + default: + return SQ_PASS; + } +} + +SQ_RCODE ProcessHeaders(SQRL_CONTROL_BLOCK *pSCB, char *pHeaders) { + BEG("ProcessHeaders()"); + // Each header ends in \r\n. + // strtok() null-terminates each token at the delimiter + char *pToken=strtok(pHeaders, "\r\n"); + while(pToken !=NULL ) { + printf(" %s\r\n", pToken); + + // Extract the Headers we are interested in + char *pName; + int len; + pName="Host: "; len=strlen(pName); + if(memcmp(pToken, pName, len)==0) { + pSCB->lpszHttpHost=pToken+len; + } + pName="Referer: "; len=strlen(pName); + if(memcmp(pToken, pName, len)==0) { + pSCB->lpszHttpReferrer=pToken+len; + } + pName="Origin: "; len=strlen(pName); + if(memcmp(pToken, pName, len)==0) { + pSCB->lpszHttpOrigin=pToken+len; + } + pToken=strtok(NULL, "\r\n"); + } + END(); + return SQ_PASS; +} diff --git a/SSP-API-Source/makefile b/SSP-API-Source/makefile new file mode 100644 index 0000000..949b2a0 --- /dev/null +++ b/SSP-API-Source/makefile @@ -0,0 +1,74 @@ + +LIBTARG = libsspapi.so + +# For http interface (openssl or mbedtls) +EX1TARG = ssphttp +# For function interface +EX2TARG = sspfunc +# For simple 'ping' function +EX3TARG = ssptest + +LIBOBJS = base64url.o browser.o client.o configdata.o criticalsection.o crypto.o database.o dbglog.o global.o handler.o handler-mbedtls.o handler-openssl.o pendingauths.o qrcode.o response.o server.o sspapi.o utils.o + +EX1OBJS = ssphttp.o +EX2OBJS = sspfunc.o +EX3OBJS = ssptest.o + +LIBLIBS = -lblowfish -ldb -llodepng -lqrencode -lsodium -lssl -lcrypto -lmbed -pthread +EX1LIBS = -lsspapi +EX2LIBS = -lsspapi +EX3LIBS = -lsspapi + +#GCC = gcc +#GCC = gcc -g +#GCC = gcc -D DEBUG_LOG +GCC = gcc -g -D DEBUG_LOG + +# Not to be confused with filenames +.PHONY: default all clean + +# Not to be deleted +.PRECIOUS: + +default: $(LIBTARG) $(EX1TARG) $(EX2TARG) $(EX3TARG) + +all: default + +clean: + -rm -f *.o + -rm -f $(LIBTARG) $(EX1TARG) $(EX2TARG) $(EX3TARG) + +SOURCES = $(wildcard *.c) +HEADERS = $(wildcard *.h) + +# Make object files $@=target, $<=first prerequisite +%.o: %.c $(HEADERS) + @echo Sources: + @echo $(SOURCES) + @echo Headers: + @echo $(HEADERS) + @echo + + $(GCC) -c -Wall -Werror -fPIC -o $@ $< + +ssphttp.o: sspmain.c $(HEADERS) + $(GCC) -c -Wall -Werror -fPIC -o ssphttp.o sspmain.c -D HTTP_INTERFACE +sspfunc.o: sspmain.c $(HEADERS) + $(GCC) -c -Wall -Werror -fPIC -o sspfunc.o sspmain.c -D FUNC_INTERFACE +ssptest.o: sspmain.c $(HEADERS) + $(GCC) -c -Wall -Werror -fPIC -o ssptest.o sspmain.c -D TEST_INTERFACE + +# Make shared library +libsspapi.so: $(LIBOBJS) + gcc -shared -o $(LIBTARG) $(LIBOBJS) $(LIBLIBS) + sudo install -m 755 libsspapi.so /usr/local/lib + sudo ldconfig + +# Make executables +ssphttp: $(EX1OBJS) $(LIBOBJS) + $(GCC) -Wall -Werror -o $(EX1TARG) $(EX1OBJS) $(EX1LIBS) + #cp ssphttp ~/Desktop/SSP-API-Demo +sspfunc: $(EX2OBJS) $(LIBOBJS) + $(GCC) -Wall -Werror -o $(EX2TARG) $(EX2OBJS) $(EX2LIBS) +ssptest: $(EX3OBJS) $(LIBOBJS) + $(GCC) -Wall -Werror -o $(EX3TARG) $(EX3OBJS) $(EX3LIBS) diff --git a/SSP-API-Source/pendingauths.c b/SSP-API-Source/pendingauths.c new file mode 100644 index 0000000..7ada196 --- /dev/null +++ b/SSP-API-Source/pendingauths.c @@ -0,0 +1,504 @@ + +// pendingauths.c + +#include "global.h" + +QUEUE PendingAuthsQueue; + +/* +=============================================================================== + DELETE PENDING AUTH ALLOCS + This is called when we're shutting down as a callback of "DeleteQueue". +=============================================================================== +*/ +void DeletePendingAuthAllocs(void *pObject) { + BEG("DeletePendingAuthAllocs)"); + PENDING_AUTHS *pPendingAuth=(PENDING_AUTHS *)pObject; + + // Note: GlobalFree() tests for a null pointer + + // if we have a next page URL, we release it + GlobalFree((void **)&pPendingAuth->pszNextPageURL); + + // if we have a login page URL, we release it + GlobalFree((void **)&pPendingAuth->pszLoginPageURL); + + END(); +} + +/* +=============================================================================== + DELETE PENDING AUTH OBJECT + This removes a pending authentication object from the pending auths queue. It + optionally deletes any per-object allocations, then deletes the object itself. +=============================================================================== +*/ +void DeletePendingAuthObject(void *pObject) { + BEG("DeletePendingAuthOject()"); + QUEUE_OBJECT *pQueueObject=(QUEUE_OBJECT *)pObject; + PENDING_AUTHS *pPendingAuth=(PENDING_AUTHS *)pObject; + + DequeueObject(&PendingAuthsQueue, pQueueObject); + + // if we have a next page URL + GlobalFree((void **)&pPendingAuth->pszNextPageURL); + + // if we have a login page URL + GlobalFree((void **)&pPendingAuth->pszLoginPageURL); + + // and release the object itself + GlobalFree((void **)&pPendingAuth); + END(); +} + +/* +=============================================================================== + LOOKUP BY NUT + This searches for the pending auth object by client query provided NUT. + If, during the search, any expired pending objects are found, they are + immediately deleted. If the target object is found its timestamp is updated. + Then the object is either read or written depending upon the UpdateObject + boolean. And a pointer to the object is also returned... +=============================================================================== +*/ +PENDING_AUTHS *LookupByNut(PENDING_AUTHS *pPendingAuth, SQ_CHAR *pNut, SQ_BOOL bUpdateObject, SQ_BOOL bProtocolNut, SQRL_CONTROL_BLOCK *pSCB){ + BEG("LookupByNut()"); +//[ +if(bProtocolNut) LOG("Looking for ProtocolNut:"); else LOG("Looking for Browser Nut:"); +LOG("[]", pNut, SQRL_NUT_LEN); +//] + SQ_CHAR aIpAddress[16]; + SQ_DWORD LowResTime=GetSystemOneSecondTime(); + + if(pSCB!=NULL) { + ObtainClientConnectionIP(aIpAddress, pSCB); + } + + EnterCriticalSection(&PendingAuthsQueue.CriticalSection); + + void *pObject=NULL; + void *pNextObject=PendingAuthsQueue.pFirstInQueue; + + while((pObject=pNextObject)!=NULL) { + pNextObject=((QUEUE_OBJECT *)pObject)->pNextObject; +//[ +//? what happens when the timer wraps around? +//] + if(LowResTime-((QUEUE_OBJECT *)pObject)->TimeStamp > PENDING_AUTH_EXP) { + DeletePendingAuthObject(pObject); + continue; // (the while loop) + } + + // choose which of our nuts we're looking up here... + SQ_CHAR *pObjectNut; + if(bProtocolNut==SQ_TRUE) { + pObjectNut=((PENDING_AUTHS *)pObject)->aProtocolNut; +//[ +LOG("pObject->ProtocolNut:"); +LOG("[]", pObjectNut, SQRL_NUT_LEN); +//] + } + else { + pObjectNut=((PENDING_AUTHS *)pObject)->aBrowserNut; +//[ +LOG("pObject->BrowserNut:"); +LOG("[]", pObjectNut, SQRL_NUT_LEN); +//] + } + + // If the nuts don't match check the next queue entry + if(strncmp(pNut, pObjectNut, SQRL_NUT_LEN)!=0){ + continue; //(the while loop) + } + +//[ +LOG("We have found a matching Nut"); +//] + // we have found a matching NUT (#1 or #2) so now we + // verify the caller's IP address if we have a pSCB + if(pSCB!=NULL){ + // we FOUND the NUT we're searching for. Was the query + // from the same IP as the original /nut/sqrl query? +//[ +LOG("IpAddress:"); +LOG("[]", aIpAddress, IPV6_BYTE_LEN); +LOG("RequestIP:"); +LOG("[]", ((PENDING_AUTHS *)pObject)->aRequestIP, IPV6_BYTE_LEN); +//] + if(strncmp(aIpAddress, ((PENDING_AUTHS *)pObject)->aRequestIP, IPV6_BYTE_LEN)!=0){ + // we had an IP mismatch with queries from the same + // browser session, which should NEVER happen... + DeletePendingAuthObject(pObject); + + // the object is gone, return NULL + pObject=NULL; + break; //(out of while) + } + } +//[ +//? compare with Lookup by CPS, it doesn't test if pPendingAuth is NULL +//] + if(pPendingAuth!=NULL) { + if(bUpdateObject==SQ_TRUE) { + // copy the object provided by our caller + memcpy(pObject, pPendingAuth, sizeof(PENDING_AUTHS)); +//[ +LOG("Writing object"); +//] + } + else{ + // or return a copy of this Pending Auth to our caller + memcpy(pPendingAuth, pObject, sizeof(PENDING_AUTHS)); +//[ +LOG("Reading object"); +//] + } + } + break; // (out of while) + } // (back to while) + + LeaveCriticalSection(&PendingAuthsQueue.CriticalSection); +//[ +if(pObject==NULL) LOG("We did not find a matching Nut"); +if(pObject!=NULL) LOG("We did find a matching Nut"); +//] + END(); + return pObject; +} + +/* +=============================================================================== + LOOKUP BY CPS + This searches for the pending auth object by Client Provided Session nonce. + If, during the search, any expired pending objects are found, they are + immediately deleted. If the target object is found its timestamp is updated. + Then the object is either read or written depending upon the UpdateObject + boolean. And a pointer to the object is also returned... +=============================================================================== +*/ +PENDING_AUTHS *LookupByCPS(PENDING_AUTHS *pPendingAuth, SQ_VOID *pCPSnonce, SQ_BOOL bUpdateObject) { + BEG("LookupByCPS()"); + // we search for these 24 chars + LOG("pCPSnonce=%s", (char *)pCPSnonce); + + SQ_DWORD LowResTime=GetSystemOneSecondTime(); + +LOG("owner: %u", PendingAuthsQueue.CriticalSection.Lock.__data.__owner); +LOG("&Lock: %p", &PendingAuthsQueue.CriticalSection.Lock); + + EnterCriticalSection(&PendingAuthsQueue.CriticalSection); + + void *pObject=NULL; + void *pNextObject=PendingAuthsQueue.pFirstInQueue; + + while((pObject=pNextObject)!=NULL) { + pNextObject=((QUEUE_OBJECT *)pObject)->pNextObject; +//[ +//? what happens when the timer wraps around? +//] + if(LowResTime-((QUEUE_OBJECT *)pObject)->TimeStamp > PENDING_AUTH_EXP){ + DeletePendingAuthObject(pObject); + continue; // (the while loop) + } + + SQ_CHAR *pObjectCPSnonce; + pObjectCPSnonce=((PENDING_AUTHS *)pObject)->aCPSNonce; + if(strncmp(pCPSnonce, pObjectCPSnonce, CPS_TOKEN_LEN)!=0){ + continue; //(the while loop) + } +//[ +//? compare with LookupByNut, it tests if pPendingAuth is NULL +//] + // we FOUND the NUT we're searching for, so we either... + if(bUpdateObject==SQ_TRUE) { + // copy the object provided by our caller + memcpy(pObject, pPendingAuth, sizeof(PENDING_AUTHS)); + } + else { + // or return a copy of this Pending Auth to our caller + memcpy(pPendingAuth, pObject, sizeof(PENDING_AUTHS)); + } + break; // (out of while) + } // (back to while) + + LeaveCriticalSection(&PendingAuthsQueue.CriticalSection); + + END(); + return pObject; +} + +/* +=============================================================================== + SET INITIAL AUTH MACS +=============================================================================== +*/ +void SetInitialAuthMacs(PENDING_AUTHS *pPendingAuth, SQRL_CONTROL_BLOCK *pSCB){ + BEG("SetInitialAuthMacs()"); + SQ_CHAR szNutText[16]; + SQ_CHAR szSqrlURL[512]; + SQ_CHAR szStringToMAC[512]; + SQ_CHAR szEncodedReferrer[2048]; + + GetUrlEncodedReferrer(szEncodedReferrer, sizeof(szEncodedReferrer), pSCB); + + // get our associated nut string and null-terminate it + memcpy(szNutText, pPendingAuth->aBrowserNut, SQRL_NUT_LEN); + szNutText[SQRL_NUT_LEN]='\0'; + + int len; + + // obtain and store the HMAC for the string: sqrl://{hostname}/sqrl?nut={-nut-} + len=sprintf(szSqrlURL, pszQRcodeFormat, pSCB->lpszHttpHost, pPendingAuth->szPathExtension, szNutText); + +LOG("Calculation of HMAC1 in SetInitialAuthMacs():"); +LOG("SqrlURL without can=:"); + + len=SqrlCvrtToBase64(szStringToMAC, sizeof(szStringToMAC), (SQ_BYTE *)szSqrlURL, len); + HMAC256(pPendingAuth->aTransactionMAC1, (SQ_BYTE *)szStringToMAC, len, aSystemKey); + + // and the HMAC for the string: sqrl://{hostname}/sqrl?nut={-nut-}&can={-referer-} + len=sprintf(szSqrlURL, pszSQlinkFormat, pSCB->lpszHttpHost, pPendingAuth->szPathExtension, szNutText, szEncodedReferrer); + +LOG("Calculation of HMAC2 in SetInitialAuthMacs():"); +LOG("SqrlURL with can=:"); + + len=SqrlCvrtToBase64(szStringToMAC, sizeof(szStringToMAC), (SQ_BYTE *)szSqrlURL, len); + HMAC256(pPendingAuth->aTransactionMAC2, (SQ_BYTE *)szStringToMAC, len, aSystemKey); + + END(); +} + +/* +============================================================================ + CREATE QUEUE + -------------------------------------------------------------------------- + Creates an empty queue object by initializing a QUEUE structure. + in: pQueue pointer to an existing QUEUE structure + out: pQueue initialized to zeros +---------------------------------------------------------------------------- +*/ +SQ_RCODE CreateQueue(QUEUE *pQueue) { + BEG("CreateQueue()"); + + memset(pQueue, 0, sizeof(QUEUE)); + InitializeCriticalSection(&pQueue->CriticalSection); + + END(); + return SQ_PASS; +} + +/* +============================================================================ + DELETE QUEUE + -------------------------------------------------------------------------- + Deletes ALL queued objects, their allocs, and the queue's critical section. + in: pQueue + in: pDestructor - call back to delete object + out: pQueue +---------------------------------------------------------------------------- +*/ + +SQ_RCODE DeleteQueue(QUEUE *pQueue, SQ_PROCPTR pDestructor) { + BEG("DeleteQueue()"); + QUEUE_OBJECT *pQueueObject; + + while((pQueueObject=Dequeue(pQueue))!=NULL) { + pDestructor(pQueueObject); + GlobalFree((void **)&pQueueObject); + } + DeleteCriticalSection(&pQueue->CriticalSection); + + END(); + return SQ_PASS; +} + +/* +============================================================================ + ENQUEUE + -------------------------------------------------------------------------- + Adds the QueueObject to the end of the QueuePointer queue. + in: pQueue + in: pNewObject + out: pQueue +---------------------------------------------------------------------------- +*/ +SQ_RCODE Enqueue(QUEUE *pQueue, QUEUE_OBJECT *pNewObject) { + BEG("EnQueue()"); + + EnterCriticalSection(&pQueue->CriticalSection); + + // Add the new object to the end of the queue + pNewObject->pPriorObject=pQueue->pLastInQueue; + pNewObject->pNextObject=0; + + if(pQueue->pLastInQueue!=0){ + // The queue is not empty, hook old last object to new one + pQueue->pLastInQueue->pNextObject=pNewObject; + } + else { + // The queue is empty, set this object as the first also + pQueue->pFirstInQueue=pNewObject; + } + + // Set this object as the last + pQueue->pLastInQueue=pNewObject; + + // Increment the number of objects in the Queue + pQueue->ObjectCount++; + + LeaveCriticalSection(&pQueue->CriticalSection); + + END(); + return SQ_PASS; +} + +/* +============================================================================ + DEQUEUE + -------------------------------------------------------------------------- + Takes (and removes) the next (first) object from the queue. + Returns the pointer to the object, or NULL if the queue is empty. + in : pQueue + out: pQueue + ret: first object or NULL +---------------------------------------------------------------------------- +*/ +QUEUE_OBJECT *Dequeue(QUEUE *pQueue) { + BEG("DeQueue()"); + + EnterCriticalSection(&pQueue->CriticalSection); + + // Get the current first queue object + QUEUE_OBJECT *pFirstInQueue=pQueue->pFirstInQueue; + + // Only proceed if the queue is not empty + if(pFirstInQueue!=NULL){ + // Make the next object the first + QUEUE_OBJECT *pQueueObject=pFirstInQueue->pNextObject; + pQueue->pFirstInQueue=pQueueObject; + + if(pQueueObject!=NULL){ + // The new first object is not NULL, set it's prior object to NULL + pQueueObject->pPriorObject=NULL; + } + else { + // The first object is NULL, so the queue is empty + pQueue->pLastInQueue=pQueueObject; + } + pQueue->ObjectCount--; + } + LeaveCriticalSection(&pQueue->CriticalSection); + + // Return the first object, or NULL if the queue is empty + END(); + return pFirstInQueue; +} + +/* +============================================================================ + DEQUEUE OBJECT + -------------------------------------------------------------------------- + Dequeues the specified object (not necessarily the first object) from + the queue. + in : pQueue + in : pQueueObject + out: pQueue +---------------------------------------------------------------------------- +*/ +SQ_RCODE DequeueObject(QUEUE *pQueue, QUEUE_OBJECT *pQueueObject) { + BEG("DeQueueObject()"); +LOG("owner: %u", pQueue->CriticalSection.Lock.__data.__owner); +LOG("&Lock: %p", &pQueue->CriticalSection.Lock); + + EnterCriticalSection(&pQueue->CriticalSection); + + // Unhook the object from it's previous object or first in queue + if(pQueueObject->pPriorObject!=NULL) { + // If there is a prior object hook it to the next object + pQueueObject->pPriorObject->pNextObject=pQueueObject->pNextObject; + } + else { + // Other wise make the next object the first + pQueue->pFirstInQueue=pQueueObject->pNextObject; + } + + // Unhook the object from it's next object or last in queue + if(pQueueObject->pNextObject!=NULL) { + pQueueObject->pNextObject->pPriorObject=pQueueObject->pPriorObject; + } + else { + pQueue->pLastInQueue=pQueueObject->pPriorObject; + } + + // Decrement the object count + pQueue->ObjectCount--; + + LeaveCriticalSection(&pQueue->CriticalSection); + + END(); + return SQ_PASS; +} + +//[ For testing with /pnd.sqrl +char *GetPendingAuths() { + // start with a null-terminated empty string + char *pszList=GlobalAlloc(1); + + char *pszFormat= + " Browser Nut: %s\r\n" + " Protocol Nut: %s\r\n" + "Sqrl Public Key: %s\r\n" + " Invitation: %s\r\n" + " CPS Nonce: %s\r\n" + "\r\n"; + + int TotalLen=1; // allow for null terminator + + PENDING_AUTHS *pPendingAuth=NULL; + void *pNextObject=PendingAuthsQueue.pFirstInQueue; + + // Don't check for errors, assume everything works + while(pNextObject!=NULL) { + pPendingAuth=(PENDING_AUTHS *)pNextObject; + pNextObject=((QUEUE_OBJECT *)pPendingAuth)->pNextObject; + + char szBrowserNut[SQRL_NUT_LEN+1]; + memcpy(szBrowserNut, pPendingAuth->aBrowserNut, SQRL_NUT_LEN); + szBrowserNut[SQRL_NUT_LEN]='\0'; + + char szProtocolNut[SQRL_NUT_LEN+1]; + memcpy(szProtocolNut, pPendingAuth->aProtocolNut, SQRL_NUT_LEN); + szProtocolNut[SQRL_NUT_LEN]='\0'; + + char szCPSNonce[CPS_TOKEN_LEN+1]; + memcpy(szCPSNonce, pPendingAuth->aCPSNonce, CPS_TOKEN_LEN); + szCPSNonce[CPS_TOKEN_LEN]='\0'; +//[ +LOG(szBrowserNut); +LOG(szProtocolNut); +LOG(pPendingAuth->szSqrlPublicKey); +LOG(pPendingAuth->szInvitation); +LOG(szCPSNonce); +//] + TotalLen=TotalLen + +strlen(pszFormat)-strlen("%s%s%s%s%s") + +strlen(szBrowserNut) + +strlen(szProtocolNut) + +strlen(pPendingAuth->szSqrlPublicKey) + +strlen(pPendingAuth->szInvitation) + +strlen(szCPSNonce) + +strlen("\r\n"); + + pszList=realloc(pszList, TotalLen); + + sprintf(strchr(pszList, '\0'), pszFormat, + szBrowserNut, + szProtocolNut, + pPendingAuth->szSqrlPublicKey, + pPendingAuth->szInvitation, + szCPSNonce); + } + return pszList; +} +//] + diff --git a/SSP-API-Source/qrcode.c b/SSP-API-Source/qrcode.c new file mode 100644 index 0000000..f09b1c2 --- /dev/null +++ b/SSP-API-Source/qrcode.c @@ -0,0 +1,107 @@ + +// qrcode.c + +#include "global.h" +#include "qrencode.h" +#include "lodepng.h" + +enum { + PIXELS_PER_CELL =4, + QUIET_ZONE_SIZE =2*PIXELS_PER_CELL +}; + +/* +=============================================================================== + SEND STRING AS QR CODE IMAGE + in: pszStringToConvert + in: pSCB +=============================================================================== +*/ +// The string to convert is of the form +// "sqrl://nut=&cps=" +// First we encode it into a QR code +// Then create an image with a quiet zone around it +// And finally send back the QR image in PNG format + +void SendStringAsQRcodeImage(SQRL_CONTROL_BLOCK *pSCB, SQ_CHAR *pszStringToConvert) { + BEG("SendStringAsQRcodeImage()"); + + // Encode the string into a QR Code + QRcode *pQRcode=QRcode_encodeString8bit(pszStringToConvert, 0, QR_ECLEVEL_L); + + // QRcodes are square + // For clarity we use separate variables for width and height + int QRwidth=pQRcode->width; + int QRheight=QRwidth; + int zone=QUIET_ZONE_SIZE; + int scale=PIXELS_PER_CELL; + + // The data is one byte per cell + // Bit 0 indicates black(1) or white(0) + // The code is scaled by the factor PIXELS_PER CELL + // It is surrounded by a zone of QUIET_ZONE_SIZE pixels (already scaled) + + // The image width and height include two zones + int IMwidth=QRwidth*scale+2*zone; + int IMheight=QRheight*scale+2*zone; + + // Allocate memory for the image + int IMarea=IMwidth*IMheight; + unsigned char *pImage=(unsigned char *)GlobalAlloc(IMarea); + + // Initialize the image to all white + memset(pImage, 0xff, IMarea); + + // Center the QR code by starting the image ndx at row=zone, col=zone + int row, col, srow, scol; + int ndx=zone*IMwidth+zone; + + // Start the cell pointer at the QR data + unsigned char *pQRcell=pQRcode->data; + + // Loop through the QRcode cell by cell + for(row=zone; row0) { + BytesToWrite=OptionalLength; + } + else { + BytesToWrite=strlen((char *)pBuffer); + } + rc=WriteClient(pSCB, pBuffer, &BytesToWrite); + + END(); + return rc; +} + +/* +=============================================================================== + RETURN 404 NOT FOUND +=============================================================================== +*/ +SQ_RCODE Return404NotFound(SQRL_CONTROL_BLOCK *pSCB) { + BEG("Return404Notfound()"); + SQ_RCODE rc=SQ_PASS; + SQ_CHAR szHeaders[2048]; + + // now we send out our response headers including a cookie... +//. what cookie? + sprintf(szHeaders, pszHttpResponseHeaderFormat, szPublicAuthDomain); + SQ_CHAR *pBuffer=HttpStatusLookup[HTTP_NOT_FOUND].pStatus; + SQ_DWORD Length=strlen(pBuffer); + + WriteResponseHeaders(pSCB, HTTP_NOT_FOUND, szHeaders, Length); + rc=WriteClient(pSCB, (SQ_BYTE *)pBuffer, &Length); + + END(); + return rc; +} +/* +=============================================================================== + RETURN 410 GONE +=============================================================================== +*/ +SQ_RCODE Return410Gone(SQRL_CONTROL_BLOCK *pSCB) { + BEG("Return410Gone()"); + SQ_RCODE rc=SQ_PASS; + SQ_CHAR szHeaders[2048]; + + // now we send out our response headers including a cookie... +//. what cookie? + sprintf(szHeaders, pszHttpResponseHeaderFormat, szPublicAuthDomain); + SQ_CHAR *pBuffer=HttpStatusLookup[HTTP_GONE].pStatus; + SQ_DWORD Length=strlen(pBuffer); + + WriteResponseHeaders(pSCB, HTTP_GONE, szHeaders, Length); + rc=WriteClient(pSCB, (SQ_BYTE *)pBuffer, &Length); + + END(); + return rc; +} diff --git a/SSP-API-Source/server.c b/SSP-API-Source/server.c new file mode 100644 index 0000000..6d417d2 --- /dev/null +++ b/SSP-API-Source/server.c @@ -0,0 +1,501 @@ + +// server.c + +/* +via HTTPS GET + +/add.sqrl?user={user ID}&acct={account ID}&name={UserHandle}&stat={status} +/add.sqrl?acct={account ID}&name={UserHandle}&stat={status} + +/rem.sqrl?user={user ID} +/rem.sqrl?acct={account ID} +/rem.sqrl?acct={account ID}&name={UserHandle} + +/lst.sqrl?acct={account ID} +/lst.sqrl?invt={invitation} +/lst.sqrl?user={user ID} + +/inv.sqrl?acct={account ID}&name={UserHandle}&stat={status} +*/ + +/* +=============================================================================== + SERVER INTERFACE +------------------------------------------------------------------------------- + This provides the implementation of the API functions used by the web server + to manage SQRL-to-Account associations. It is called when the server wishes to + add, remove, enumerate or invite a SQRL user to or from a web server account. +=============================================================================== +*/ + +#include "global.h" + +/* +=============================================================================== + DE-ESCAPE FORM DATA + This removes URL-encoding from a form's POST data. Since the resulting buffer + will always be smaller than the source, we perform an in-place conversion. +=============================================================================== +*/ +void DeEscapeFormData(SQ_CHAR *pszBufferToDeEscape) { + BEG("DeEscapeFormData()"); + + // Set up our source and destination string pointers + char *src=pszBufferToDeEscape; + char *dst=pszBufferToDeEscape; + + while(1) { + // Get the next character + char c=*src; + src++; + + // if it's a "+" + if(c=='+') { + // convert it back into a space + c=' '; + } + // if it's a URL escape character + else if(c=='%') { + // Convert the next two hex characters to binary + c=HexToNybble(*src)<<4; + src++; + c|=HexToNybble(*src); + src++; + } + // put the converted character back out + *dst=c; + dst++; + + // Exit if we are at the end of the string + if(c=='\0') break; + } + END(); +} + +/* +=============================================================================== + PARSE QUERY PARAMS +------------------------------------------------------------------------------- + Given a pointer to an ampersand-delimited (&) null-terminated string, this + converts all '&' into nulls to zero-terminate the arguments and, for each + parameter found, adds a pointer to the argument structure. If the parameter + is NOT present the value placed into the structure will be the address of + szNull as distinct from a pointer to the parameter's null. This distinction + is important since it allows the caller to distinguish between a parameter + which is present but whose value is null from a parameter that's not present. + +=============================================================================== +*/ +void ParseQueryParams(QUERY_PARAMS *pQueryParams, SQ_CHAR *pszQueryString) { + BEG("ParseQueryParams()"); + + // look for instances of each of the tokens and set the pointer + // to the token's parameter which follows the separating '=' + + // we scan through this buffer of parameters + // remove '+' and '%xx' URL escapements + DeEscapeFormData(pszQueryString); + + const char *pszQueryTokenList[]={ + "user=", + "acct=", + "name=", + "stat=", + "invt=" + }; + + // Set up an array to access the QUERY_PARAMS elements + SQ_CHAR **ppQueryParams[]={ + &pQueryParams->pszSqrlUser, + &pQueryParams->pszAccount, + &pQueryParams->pszUserHandle, + &pQueryParams->pszStatus, + &pQueryParams->pszInvite + }; + + int i; + int n=sizeof(pszQueryTokenList)/sizeof(pszQueryTokenList[0]); + char *ptr; + + // for each token + for(i=0; i'9') { + pSqrlPublicIdentity[0]='\0'; + break; + } + } + } + END(); +} + +/* +=============================================================================== + RETURN LIST OF ASSOCIATIONS +------------------------------------------------------------------------------- + The Add/Remove/List queries each return a list of SQRL IDs, User Handles and + the Status currently associated with the account after the query processing. + This common function handles the return of that list from any of functions. +=============================================================================== +*/ +SQ_RCODE ReturnListOfAssociations(SQ_CHAR *pszAccount, SQRL_CONTROL_BLOCK *pSCB) { + BEG("ReturnListOfAssociations()"); + SQ_RCODE rc=SQ_FAIL; + SQ_CHAR *pszList; + + // The caller must ensure pszAccount is not NULL + + // given the account ID string, lookup every record we have with that + // account ID, format a possibly-multiline string and return a global + // allocation which we will then return to our caller + + pszList=GetListOfAssociations(pszAccount); + LogTheQueryAndReply(pszList, pSCB); + + rc=ReturnStringToCaller(pszList, pSCB); + + GlobalFree((void **)&pszList); + END(); + return rc; +} + +/* +=============================================================================== + UPDATE BY SQRL USER +------------------------------------------------------------------------------- + We look up a unique SQRL record by the user's SQRL identity, then add any + of the other information that the caller has provided to that record. +=============================================================================== +*/ +SQ_RCODE UpdateBySqrlUser(QUERY_PARAMS *pQueryParams) { + BEG("UpdateBySqrlUser()"); + SQ_RCODE rc=SQ_FAIL; + SQRL_ASSOCIATIONS SqrlAssoc; + ASSOC_REC_DATA *pAssocRecData=&SqrlAssoc.AssocRecData; + + // lookup the database record by the user's SQRL identity + if(GetRecordByUserID(&SqrlAssoc, pQueryParams->pszSqrlUser)==SQ_FAIL) { + return rc; + } + + // we found the record by the user's SQRL identity so now we update the + // record with any additional info the caller provided in their query + if(pQueryParams->pszAccount!=pszNull) { + strncpy(pAssocRecData->szAccount, pQueryParams->pszAccount, 64); + } + if(pQueryParams->pszUserHandle!=pszNull) { + strncpy(pAssocRecData->szUserHandle, pQueryParams->pszUserHandle, 64); + } + if(pQueryParams->pszStatus!=pszNull) { + strncpy(pAssocRecData->szStatus, pQueryParams->pszStatus, 64); + } + // and now we update the record with the newly updated data + rc=StoreSqrlRecord(&SqrlAssoc); + + END(); + return rc; +} + +/* +=============================================================================== + ADD ASSOCIATION +------------------------------------------------------------------------------- + /add.sqrl?user={user ID}&acct={account ID}&name={UserHandle}&stat={status} + /add.sqrl?acct={account ID}&name={UserHandle}&stat={status} +------------------------------------------------------------------------------- + This function allows the webserver to associate a newly authenticating + SQRL ID with an existing webserver account and/or to provide or update + an associated user handle and status with the association. +=============================================================================== +*/ +SQ_RCODE AddAssociation(SQRL_CONTROL_BLOCK *pSCB) { + BEG("AddAssociation()"); + SQ_RCODE rc=SQ_FAIL; + QUERY_PARAMS QueryParams; + + ParseQueryParams(&QueryParams, pSCB->lpszQueryString); + + // if we have an Account, find it, otherwise return fail + if(QueryParams.pszAccount!=NULL) { + // do we have a User identity? + if(QueryParams.pszSqrlUser!=NULL) { + UpdateBySqrlUser(&QueryParams); + } + else { + UpdateByAccount(&QueryParams, /*Remove=*/SQ_FALSE); + } + rc=ReturnListOfAssociations(QueryParams.pszAccount, pSCB); + } + END(); + return rc; +} + +/* +=============================================================================== + REMOVE ASSOCIATION +------------------------------------------------------------------------------- + /rem.sqrl?user={user ID} + /rem.sqrl?acct={account ID} + /rem.sqrl?acct={account ID}&name={UserHandle} +------------------------------------------------------------------------------- + This deletes a SQRL/Account association. If a SQRL ID is present, since they + are guaranteed to be unique, that record is removed. Otherwise, if an Account + is supplied, one or more of those will be removed. If no UserHandle is supplied + ALL matching accounts will be removed. Otherwise, if a UserHandle is given the + record matching both Account and UserHandle will be removed. +=============================================================================== +*/ +void RemoveAssociation(SQRL_CONTROL_BLOCK *pSCB) { + BEG("RemoveAssociation()"); + QUERY_PARAMS QueryParams; + SQRL_ASSOCIATIONS SqrlAssoc; + + ParseQueryParams(&QueryParams, pSCB->lpszQueryString); + + // if the caller provided us with a SQRL identity, we simply delete it + if(QueryParams.pszSqrlUser!=NULL) { + if(GetRecordByUserID(&SqrlAssoc, QueryParams.pszSqrlUser)==SQ_PASS) { + QueryParams.pszAccount=SqrlAssoc.AssocRecData.szAccount; + DeleteSqrlRecord(&SqrlAssoc); + } + } + // if we have an account ID, find it and delete + else if(QueryParams.pszAccount!=NULL) { + UpdateByAccount(&QueryParams, /*Remove=*/SQ_TRUE); + } + if(QueryParams.pszAccount!=NULL) { + ReturnListOfAssociations(QueryParams.pszAccount, pSCB); + } + END(); +} + +/* +=============================================================================== + LIST ASSOCIATIONS +------------------------------------------------------------------------------- + /lst.sqrl?acct={account ID} + /lst.sqrl?invt={invitation} + /lst.sqrl?user={user ID} +------------------------------------------------------------------------------- + When given an Account ID, this returns a list of all SQRL user associations + currently associated with the provided web server account. When given an + invitation or a SqrlUser, it returns the item matching that specification. +=============================================================================== +*/ +void ListAssociations(SQRL_CONTROL_BLOCK *pSCB) { + BEG("ListAssociations()"); + QUERY_PARAMS QueryParams; + SQ_CHAR szUrlEncodedName[256]; + SQRL_ASSOCIATIONS SqrlAssoc; + ASSOC_REC_DATA *pAssocRecData=&SqrlAssoc.AssocRecData; + SQ_CHAR szLineItem[512]; + + ParseQueryParams(&QueryParams, pSCB->lpszQueryString); + + do { + // if the caller provided an ACCT= parameter we're being asked to list + // all associations with that account. + if(QueryParams.pszAccount!=NULL) { + ReturnListOfAssociations(QueryParams.pszAccount, pSCB); + END(); + return; + } + + // it's not an enumeration of multiple associations so we'll be + // retrieving a single record based upon our selection specification + + // let's check to see whether we were given an invitation to find... + if(QueryParams.pszInvite!=NULL) { + if(GetRecordByInvitation(&SqrlAssoc, QueryParams.pszInvite)==SQ_FAIL) { + // if our lookup failed, we're finished + ReturnStringToCaller((char *)pszNull, pSCB); + break; + } + } + else if(QueryParams.pszSqrlUser!=NULL) { + if(GetRecordByUserID(&SqrlAssoc, QueryParams.pszSqrlUser)==SQ_FAIL) { + // if our lookup failed, we're finished + ReturnStringToCaller((char *)pszNull, pSCB); + break; + } + } + else { + ReturnStringToCaller((char *)pszNull, pSCB); + break; + } + + // make sure the user's provided name is URL safe + UrlEncode(szUrlEncodedName, pAssocRecData->szUserHandle); + + // check to see whether we have a valid invitation. If not, blank it + VerifyValidInvitation(pAssocRecData->aSqrlPublicIdentity); + + // we've retrieved the item to return based upon the provided criteria + // so now we format the standard data items into a string and return them + sprintf(szLineItem, pszEnumerationFormat, SqrlAssoc.szSqrlUser, + pAssocRecData->szAccount, szUrlEncodedName, + pAssocRecData->szStatus, &pAssocRecData->aSqrlPublicIdentity[1]); + + ReturnStringToCaller(szLineItem, pSCB); + } while (0); // once + END(); +} + +/* +=============================================================================== + INVITE ASSOCIATION +------------------------------------------------------------------------------- + /inv.sqrl?acct={account ID}&name={UserHandle}&stat={status} +------------------------------------------------------------------------------- + This creates a new pending invitation record for the provided web server + acct identity. It assigns this a pseudo SQRL ID flagged by a period '.' + character followed by 20 decimal digits. This is placed into the SQRL ID + field and is also returned to the user as the response to this query. +=============================================================================== +*/ +void InviteAssociation(SQRL_CONTROL_BLOCK *pSCB) { + BEG("InviteAssociation"); + QUERY_PARAMS QueryParams; + SQRL_ASSOCIATIONS SqrlAssoc; + ASSOC_REC_DATA *pAssocRecData=&SqrlAssoc.AssocRecData; + + ParseQueryParams(&QueryParams, pSCB->lpszQueryString); + + memset(&SqrlAssoc, 0, sizeof(SQRL_ASSOCIATIONS)); + + // place a new unique .{20-char} token into the SQRL public key field + pAssocRecData->aSqrlPublicIdentity[0]='.'; + + GetUnique20digitToken((char *)&pAssocRecData->aSqrlPublicIdentity[1], SQ_FALSE); + + // place the account identifier into the SQRL association record + + strncpy(pAssocRecData->szAccount, QueryParams.pszAccount, 65); + strncpy(pAssocRecData->szUserHandle, QueryParams.pszUserHandle, 65); + strncpy(pAssocRecData->szStatus, QueryParams.pszStatus, 65); + StoreSqrlRecord(&SqrlAssoc); + + ReturnStringToCaller((SQ_CHAR *)&pAssocRecData->aSqrlPublicIdentity[1], pSCB); + + END(); +} + +//.[ For Testing +/* +=============================================================================== + ACCEPT INVITATION +------------------------------------------------------------------------------- + /acc.sqrl?user={user ID}&invt={invitation} +------------------------------------------------------------------------------- + We are brought here when an authenticated SQRL user has filled-in and + accepted an invitation to join an existing website account. + At this point TWO SQRL associations will exist: The association of the SQRL + user which will only contain the three SQRL identity keys and SQRL options. + There will also be an association created by the website's invitation request. + That request will contain the AccountID, UserHandle and Status. So our task + here is to MERGE these two pending associations into a single permanent static + association. + + We lookup the invitation to confirm its validity. If it's found we retain its + Account, Username & Status data then delete the invitation. We then use + /add.sqrl?sqrl={SQRL ID}&acct={account ID}&user={UserHandle}&stat={status} + to merge the newly obtained AccountID, Userhandle and Status to the new SQRL. +=============================================================================== +*/ +SQ_RCODE AcceptInvitation(SQRL_CONTROL_BLOCK *pSCB) { + BEG("AcceptInvitation"); + SQ_RCODE rc; +// SQ_CHAR szOriginalCode[32]; +// SQ_CHAR szCompressedCode[32]; +// SQ_CHAR szListInvitedUserQuery[512]; +// SQ_CHAR szSqrlUser[16]; + QUERY_PARAMS QueryParams; + SQRL_ASSOCIATIONS SqrlAssocRecord; + ASSOC_REC_DATA *pAssocRecData=&SqrlAssocRecord.AssocRecData; + + // Get the UserID and 20-digit invitation + ParseQueryParams(&QueryParams, pSCB->lpszQueryString); + +//[ +LOG("QueryParams"); +LOG(" SqrlUser: %s", QueryParams.pszSqrlUser); +LOG(" Account: %s", QueryParams.pszAccount); +LOG("UserHandle: %s", QueryParams.pszUserHandle); +LOG(" Status: %s", QueryParams.pszStatus); +LOG(" Invite: %s", QueryParams.pszInvite); +//] + + // Lookup the invitation in the database + if(GetRecordByInvitation(&SqrlAssocRecord, QueryParams.pszInvite)==SQ_FAIL + || strlen(pAssocRecData->szAccount)==0) { + ReturnStringToCaller((char *)pszNull, pSCB); + END(); + return SQ_FAIL; + } + + // Copy the invitation's account, handle and status into QueryParms + QueryParams.pszAccount=pAssocRecData->szAccount; + QueryParams.pszUserHandle=pAssocRecData->szUserHandle; + QueryParams.pszStatus=pAssocRecData->szStatus; + +//[ +LOG("QueryParams"); +LOG(" SqrlUser: %s", QueryParams.pszSqrlUser); +LOG(" Account: %s", QueryParams.pszAccount); +LOG("UserHandle: %s", QueryParams.pszUserHandle); +LOG(" Status: %s", QueryParams.pszStatus); +LOG(" Invite: %s", QueryParams.pszInvite); +//] + + // Update the invited SqrlUser + UpdateBySqrlUser(&QueryParams); + + // Remove the invitation record from the database + rc=DeleteSqrlRecord(&SqrlAssocRecord); + + ReturnListOfAssociations(QueryParams.pszAccount, pSCB); + + END(); + return rc; +} + +//.] diff --git a/SSP-API-Source/sqtypes.h b/SSP-API-Source/sqtypes.h new file mode 100644 index 0000000..03f2ebd --- /dev/null +++ b/SSP-API-Source/sqtypes.h @@ -0,0 +1,48 @@ + +#ifndef SQTYPES_H +#define SQTYPES_H + +#include + +typedef void SQ_VOID; +typedef char SQ_CHAR; +typedef uint8_t SQ_BYTE; +typedef uint16_t SQ_WORD; +typedef uint32_t SQ_DWORD; +typedef uint64_t SQ_QWORD; + +typedef void(*SQ_PROCPTR)(void *); + +typedef enum SQ_BOOL_T{ + SQ_TRUE = (1==1), + SQ_FALSE = !SQ_TRUE +} SQ_BOOL; + +typedef enum SQ_RCODE_T{ + SQ_PASS = 0, + SQ_FAIL = ~SQ_PASS +} SQ_RCODE; + +typedef struct SQRL_RESPONSE_T { + SQ_CHAR *pszHeaders; + SQ_BYTE *pData; + SQ_DWORD DataLen; +} SQRL_RESPONSE; + +typedef struct SQRL_CONTROL_BLOCK_T { + SQ_CHAR *lpszMethod; + SQ_CHAR *lpszPathInfo; + SQ_CHAR *lpszQueryString; + SQ_DWORD DataLen; + SQ_CHAR *lpData; + SQ_CHAR *lpszHttpHost; + SQ_CHAR *lpszHttpReferrer; + SQ_CHAR *lpszRemoteAddr; + const char *lpszHttpOrigin; + SQ_CHAR szServerPort[5+1]; // max "65535" + + SQ_VOID *lpHandlerStruct; + SQRL_RESPONSE *pResponse; +} SQRL_CONTROL_BLOCK; + +#endif diff --git a/SSP-API-Source/sspapi.c b/SSP-API-Source/sspapi.c new file mode 100644 index 0000000..cc9b5b1 --- /dev/null +++ b/SSP-API-Source/sspapi.c @@ -0,0 +1,256 @@ + +// sspapi.c api shared library interface + +#include "global.h" + +SQ_CHAR *SSP_Ping() { + BEG("SSP_Ping()"); + END(); + return "Ping!\r\n"; +} + +SQ_RCODE SSP_ResetCounter() { + BEG("SSP_ResetCounter()"); + SQ_RCODE rc=SetCfgItem(CFG_MONOTONIC_COUNTER, "0000000000000000"); + bCounterReset=SQ_TRUE; + END(); + return rc; +} +SQ_RCODE SSP_InitSqrlCfgData() { + BEG("SSP_InitSqrlCfgData()"); + SQ_RCODE rc=InitSqrlCfgData(); + END(); + return rc; +} +SQ_RCODE SSP_InitSqrlSystem() { + BEG("SSP_InitSqrlSystem()"); + SQ_RCODE rc=InitSqrlSystem(); + END(); + return rc; +} +SQ_RCODE SSP_InitSqrlHandler() { + BEG("SSP_InitSqrlHandler()"); + SQ_RCODE rc=InitSqrlHandler(); + END(); + return rc; +} +SQ_RCODE SSP_ShutDownSqrlSystem() { + BEG("SSP_ShutDownSqrlSystem()"); + SQ_RCODE rc=ShutDownSqrlSystem(); + END(); + return rc; +} + +void SSP_InitResponse(SQRL_RESPONSE *pResponse) { + BEG("InitResponse()"); + pResponse->pszHeaders=NULL; + pResponse->pData=NULL; + pResponse->DataLen=0; + END(); +} +void SSP_FreeResponse(SQRL_RESPONSE *pResponse) { + BEG("FreeResponse()"); + GlobalFree((void **)&pResponse->pszHeaders); + GlobalFree((void **)&pResponse->pData); + SSP_InitResponse(pResponse); + END(); +} +void SSP_SendRequest(SQRL_CONTROL_BLOCK *pSCB) { + BEG("SSP_SendRequest()"); + LOG(" Method: %s", pSCB->lpszMethod); + LOG(" Path Info: %s", pSCB->lpszPathInfo); + LOG("QueryString: %s", pSCB->lpszQueryString); + HttpExtensionProc(pSCB); + END(); +} + +//[ +void SQ_RevertToSelf() { + BEG("RevertToSelf()"); + LOG("Stub"); + // Implement as required + END(); +} +//] + +/* +=============================================================================== + HTTP EXTENSION PROC +------------------------------------------------------------------------------ + This receives, sanity checks, and appropriately routes to the appropriate + sub-handler all invocations of this handler of the form "/xxx.sqrl?..." +------------------------------------------------------------------------------- +*/ +void HttpExtensionProc (SQRL_CONTROL_BLOCK *pSCB) { +//[ +LOG(""); +LOG("****************************************************************"); +LOG("****************************************************************"); +LOG(""); +//]] + BEG("HttpExtensionProc()"); +do { + SQ_RevertToSelf(); + + if(SqrlApiRunning==SQ_FALSE) { + break; + } + + char *pMethod=pSCB->lpszMethod; + if(pMethod==NULL) { + Return404NotFound(pSCB); + break; + } + // Convert to lower case and return if not GET or POST + // (note this converts the null after GET to a space) + SQ_DWORD Method=*(SQ_DWORD *)pMethod | 0x20202020; + if((Method!=*(SQ_DWORD *)"get ") && (Method!=*(SQ_DWORD *)"post")) { + Return404NotFound(pSCB); + break; + } + + // Parse the Path Info + // format: "/xxx.sqrl" (9 characters) + + char *pPathInfo=pSCB->lpszPathInfo; + if(strlen(pPathInfo)!=PATH_INFO_LEN){ + Return404NotFound(pSCB); + break; + } + + // Make a copy so we can convert to lowercase + char aPathInfo[PATH_INFO_LEN]; + for(int i=0; i====================== + + if(ObjectName==*(SQ_DWORD *)"nut.") GetSessionNut(pSCB); else + if(ObjectName==*(SQ_DWORD *)"png.") GetQRcode(pSCB); else + if(ObjectName==*(SQ_DWORD *)"pag.") GetNextPage(pSCB); else + +//[ +//. For development + if(ObjectName==*(SQ_DWORD *)"sup.") ListSupersededIDs(pSCB); else + if(ObjectName==*(SQ_DWORD *)"pnd.") ListPendingAuths(pSCB); else + if(ObjectName==*(SQ_DWORD *)"bdb.") ListDatabase(pSCB); else +//] + //=====================< SQRL CLIENT QUERY >===================== + + if(ObjectName==*(SQ_DWORD *)"cli." && Method==*(SQ_DWORD *)"post") { + HandleClientQuery(pSCB); + } + + //=====================< WEBSERVER QUERIES >===================== + + else { + if(VerifyPrivateQuery(pSCB)==SQ_FAIL){ + Return404NotFound(pSCB); + break; + } + + if(ObjectName==*(SQ_DWORD *)"cps.") SubmitCpsAuth(pSCB); else + if(ObjectName==*(SQ_DWORD *)"add.") AddAssociation(pSCB); else + if(ObjectName==*(SQ_DWORD *)"rem.") RemoveAssociation(pSCB); else + if(ObjectName==*(SQ_DWORD *)"lst.") ListAssociations(pSCB); else + if(ObjectName==*(SQ_DWORD *)"inv.") InviteAssociation(pSCB); else +//[ +//. For development (or perhaps added to the api) + if(ObjectName==*(SQ_DWORD *)"acc.") AcceptInvitation(pSCB); else +//] + Return404NotFound(pSCB); + break; + } +} +while(0); // once + +//[ +LOG(""); +LOG("****************************************************************"); +LOG("****************************************************************"); +LOG(""); +//]] + END(); +} + +/* +=============================================================================== + GET URL ENCODED REFERRER +------------------------------------------------------------------------------- + The browser's SQRL CPS HREF link needs to have a 'can=' cancel term which will + be the page which initiates the SQRL authentication. We capture the "REFERER" + header value when the browser requests /nut.sqrl and we (a) return it in the + query response and (b) use to generate the HMAC to verify the client's query. +=============================================================================== +*/ +void GetUrlEncodedReferrer(SQ_CHAR *pszEncodedPageURL, SQ_DWORD EncBufLen, SQRL_CONTROL_BLOCK *pSCB) { + BEG("GetUrlEncodedReferrer()"); + + int siz=0; + if(pSCB->lpszHttpReferrer !=NULL) { + siz=SqrlCvrtToBase64(pszEncodedPageURL, EncBufLen, (SQ_BYTE *)pSCB->lpszHttpReferrer, strlen(pSCB->lpszHttpReferrer)); + } + pszEncodedPageURL[siz]='\0'; + + LOG("PageReferrer: %s", pSCB->lpszHttpReferrer); + LOG("EncodedPageURL: %s", pszEncodedPageURL); + END(); +} + +/* +=============================================================================== + INIT SQRL SYSTEM API +------------------------------------------------------------------------------- + This is called once on startup. +=============================================================================== +*/ + +SQ_RCODE InitSqrlSystem() { + BEG("InitSqrlSystem()"); + SQ_RCODE rc=SQ_PASS; + remove("SSPAPI.log"); + SqrlApiRunning=SQ_TRUE; + +//[ for development +// We need this because the BEG, END and LOG macros use global variables +rc|=InitializeCriticalSection(&DebugCriticalSection); +//] + rc|=InitializeCriticalSection(&IncDataCriticalSection); + rc|=CreateQueue(&PendingAuthsQueue); + rc|=OpenSqrlDatabaseFiles(); + + // If any initialization failed rc will be SQ_FAIL + END(); + return rc; +} + +/* +=============================================================================== + SHUTDOWN SQRL SYSTEM API + This performs any graceful shutdown work required. +=============================================================================== +*/ +SQ_RCODE ShutDownSqrlSystem() { + BEG("ShutdownSqrlSystem()"); + SQ_RCODE rc=SQ_PASS; + + // Clear our 'running' flag to terminate async's + SqrlApiRunning=SQ_FALSE; + + rc|=DeleteCriticalSection(&IncDataCriticalSection); + rc|=DeleteQueue(&PendingAuthsQueue, (SQ_PROCPTR)DeletePendingAuthAllocs); + rc|=CloseBerkeleyDBs(); + + END(); + #ifdef LOGFILE + if(pLogFile!=NULL) fclose(pLogFile); + #endif + return rc; +} diff --git a/SSP-API-Source/sspapi.h b/SSP-API-Source/sspapi.h new file mode 100644 index 0000000..bc829a1 --- /dev/null +++ b/SSP-API-Source/sspapi.h @@ -0,0 +1,22 @@ + +// sspapi.h "public" library functions + +#ifndef SSPAPI_H +#define SSPAPI_H + +#include "sqtypes.h" + +SQ_CHAR *SSP_Ping(); +//[ For Testing +SQ_RCODE SSP_ResetCounter(); +//] +SQ_RCODE SSP_InitSqrlCfgData(); +SQ_RCODE SSP_InitSqrlSystem(); +SQ_RCODE SSP_InitSqrlHandler(); +SQ_RCODE SSP_ShutDownSqrlSystem(); + +void SSP_InitResponse(SQRL_RESPONSE *pResponse); +void SSP_SendRequest(SQRL_CONTROL_BLOCK *pSCB); +void SSP_FreeResponse(SQRL_RESPONSE *pResponse); + +#endif diff --git a/SSP-API-Source/sspmain.c b/SSP-API-Source/sspmain.c new file mode 100644 index 0000000..e2016d7 --- /dev/null +++ b/SSP-API-Source/sspmain.c @@ -0,0 +1,338 @@ + +// sspmain.c - main() for TEST, HTTP or FUNC interface to SSP-API library + +#include + +#include "dbglog.h" +#include "sspapi.h" + +#ifdef TEST_INTERFACE +// A minimal libsspapi.so for developing a PHP Extension +int main(int argc, char *argv[]) { + Log("main() TEST_INTERFACE"); + + // Just call Ping() to see if we are working + printf("%s", SSP_Ping()); + printf("\r\n"); +} +#endif + +#ifdef HTTP_INTERFACE +int main(int argc, char *argv[]) { + LOG("main() HTTP_INTERFACE"); + + int err=0; + +//[ For TESTING + printf("%s", SSP_Ping()); + printf("\r\n"); +// SSP_ResetCounter(); // reset the monotonic counter so we get repeatable nut values +//] + do { + // Initializations + if(SSP_InitSqrlCfgData()!=SQ_PASS) { + printf("Error: Unable to configure the Sqrl System\r\n"); + err=1; + break; + } + if(SSP_InitSqrlSystem()!=SQ_PASS) { + printf("Error: Unable to initialize the Sqrl System\r\n"); + err=2; + break; + } + + // The handler runs until stopped + if(SSP_InitSqrlHandler()!=SQ_PASS) { + printf("Error: Unable to initialize the Http Handler Server\r\n"); + err=3; + break; + } + + // Graceful exit + if(SSP_ShutDownSqrlSystem()!=SQ_PASS) { + printf("Error: Unable to shutdown the Sqrl System\r\n"); + err=4; + break; + } + } while(0); // once + + return err; +} +#endif + +#ifdef FUNC_INTERFACE +void PrintResponse(SQRL_RESPONSE *pR) { + printf("Resp Headers (%d):\r\n%s\r\n", (int)strlen(pR->pszHeaders), pR->pszHeaders); + if(pR->DataLen==0) { + printf("(no data)\r\n"); + } + else { + printf("Resp Data (%d):\r\n", pR->DataLen); + printf(""); + + // Print characters or bytes depending on content + SQ_BYTE *a=pR->pData; + int n=pR->DataLen; + int i; + for(i=0; i0x7f) break; + } + if(ipData[i]); + } + } + else { + // Print characters + for(i=0; ipData[i]); + } + } + printf("\r\n"); + } +} + +extern void *GlobalAlloc(SQ_DWORD); +extern void GlobalFree(void **); +extern void DecodeBase64szAndStore(SQ_CHAR **, SQ_CHAR *); +extern void HttpExtensionProc(SQRL_CONTROL_BLOCK *pSCB); + +void DecodeResponse(SQRL_RESPONSE *pR) { + SQ_CHAR *pszServer=GlobalAlloc(pR->DataLen+1); + memcpy(pszServer, pR->pData, pR->DataLen); + SQ_CHAR *pszServerDecode; + DecodeBase64szAndStore(&pszServerDecode, pszServer); + printf("Server Decode:\r\n%s", pszServerDecode); + GlobalFree((void **)&pszServer); + GlobalFree((void **)&pszServerDecode); +} + +char *pClientNutQuery="nut=3yUP9OMU0gMA"; +char *pClientCmdQuery= +"client=dmVyPTENCmNtZD1xdWVyeQ0KaWRrPXA5MHpQOEhFalFMU056bFI5bDRfUVdPeU1pVTdyMVM2aUdXWGNPblBMUEENCm9wdD1jcHN-c3VrDQo&server=c3FybDovL3Nxcmwuc2VydmVyLmZwZjo4NDQzL2NsaS5zcXJsP251dD0zeVVQOU9NVTBnTUEmY2FuPWFIUjBjSE02THk5M1pXSXVjMlZ5ZG1WeUxtWndaaTl6YVdkdWFXNA&ids=t6EFv8QS_fk3CD_ywTLKaoZuYYh8hLPgBCmpeqhyFQrvEfiCQPq9C1G3eTKKvuiQ0TAdhBf8v--OF5efL_IFBw"; + +char *pClientNutIdent="nut=e695TAlW96QA"; +char *pClientCmdIdent= +"client=dmVyPTENCmNtZD1pZGVudA0KaWRrPXA5MHpQOEhFalFMU056bFI5bDRfUVdPeU1pVTdyMVM2aUdXWGNPblBMUEENCm9wdD1jcHN-c3VrDQo&server=dmVyPTENCm51dD1lNjk1VEFsVzk2UUENCnRpZj01DQpxcnk9L2NsaS5zcXJsP251dD1lNjk1VEFsVzk2UUENCnN1az1BeTZkdkVaUGRITDNEUjhGYngwcWtkM0FwRmVtd29kSFVsQlBmZ1J5Q2hJDQo&ids=CQ040jXDHnvAvAxi9ehl_Z4_TaF036amCoVAXCfwJQcueW0rTVag4o9WZPRmTKjD-V_oMBtQshaEqB_9JPZDBg"; + +void SetUpSqrlControlBlock( + SQRL_CONTROL_BLOCK *pSCB, + char *pszMethod, + char *pszPathInfo, + char *pszQueryString, + int DataLen, + void *pData, + char *pszHttpHost, + char *pszHttpReferrer, + char *pszRemoteAddr, + char *pszHttpOrigin, + char *pszServerPort, + SQRL_RESPONSE *pResponse + ) { + + pSCB->lpszMethod=pszMethod; + pSCB->lpszPathInfo=pszPathInfo; + pSCB->lpszQueryString=pszQueryString; + pSCB->DataLen=DataLen; + pSCB->lpData=pData; + + pSCB->lpszHttpHost=pszHttpHost; // sqrl.server:8443 + pSCB->lpszHttpReferrer=pszHttpReferrer; + pSCB->lpszRemoteAddr=pszRemoteAddr; + pSCB->lpszHttpOrigin=pszHttpOrigin; + strcpy(pSCB->szServerPort, pszServerPort); //"8443"); + pSCB->lpHandlerStruct=NULL; + pSCB->pResponse=pResponse; + +printf("\r\n"); +printf("*** Method: %s\r\n", pSCB->lpszMethod); +printf("*** PthInf: %s\r\n", pSCB->lpszPathInfo); + +} + +int main(int argc, char *argv[]) { + LOG("main() FUNC_INTERFACE"); + +//[ For TESTING + printf("%s", SSP_Ping()); + printf("\r\n"); +// SSP_ResetCounter(); // reset the monotonic counter so we get repeatable nut values +//] + // Initializations + if(SSP_InitSqrlCfgData()!=SQ_PASS) { + printf("Error: Unable to configure the Sqrl System\r\n"); + return 1; + } + if(SSP_InitSqrlSystem()!=SQ_PASS) { + printf("Error: Unable to initialize the Sqrl System\r\n"); + return 2; + } + + // Simulate HTTP Queries + enum {NutEqLen=strlen("nut=")+strlen("nutnutnutnut")}; + char szNutEq[NutEqLen+1]; +// char aPostData[1024]; + SQRL_CONTROL_BLOCK scb; + SQRL_RESPONSE rsp; + + // Get Nut + SetUpSqrlControlBlock( + &scb, + "GET", + "/nut.sqrl", + "", + 0, + NULL, + "sqrl.server:8443", + "https://web.server/signin", + "192.168.1.100", + "https://web.server", + "8443", + &rsp + ); + SSP_InitResponse(&rsp); + SSP_SendRequest(&scb); + PrintResponse(&rsp); + + memcpy(szNutEq, rsp.pData, NutEqLen); + szNutEq[NutEqLen]='\0'; + + SSP_FreeResponse(&rsp); + + // Get QRcode + SetUpSqrlControlBlock( + &scb, + "GET", + "/png.sqrl", + szNutEq, + 0, + NULL, + "sqrl.server:8443", + "https://web.server/signin", + "192.168.1.100", + NULL, + "8443", + &rsp + ); + SSP_InitResponse(&rsp); + SSP_SendRequest(&scb); + PrintResponse(&rsp); + + SSP_FreeResponse(&rsp); + +/* + // Get Next Page + SetUpSqrlControlBlock( + &scb, + "GET", + "/pag.sqrl", + szNutEq, + 0, + NULL, + "sqrl.server:8443", + "https://web.server/signin", + "192.168.1.100", + "https://web.server", + "8443", + &rsp + ); + SSP_InitResponse(&rsp); + SSP_SendRequest(&scb); + PrintResponse(&rsp); + + SSP_FreeResponse(&rsp); +*/ + + // Sign In + SetUpSqrlControlBlock( + &scb, + "POST", + "/cli.sqrl", + pClientNutQuery, + strlen(pClientCmdQuery), + pClientCmdQuery, + "sqrl.server:8443", + "https://web.server/signin", + "192.168.1.100", + "https://web.server", + "8443", + &rsp + ); + SSP_InitResponse(&rsp); + SSP_SendRequest(&scb); + PrintResponse(&rsp); + DecodeResponse(&rsp); + SSP_FreeResponse(&rsp); + + SetUpSqrlControlBlock( + &scb, + "POST", + "/cli.sqrl", + pClientNutIdent, + strlen(pClientCmdIdent), + pClientCmdIdent, + "sqrl.server:8443", + "https://web.server/signin", + "192.168.1.100", + "https://web.server", + "8443", + &rsp + ); + SSP_InitResponse(&rsp); + SSP_SendRequest(&scb); + PrintResponse(&rsp); + DecodeResponse(&rsp); + SSP_FreeResponse(&rsp); + + + // Submit CPS Authentication + SetUpSqrlControlBlock( + &scb, + "GET", + "/cps.sqrl", + "000000000000000000000000", + 0, + NULL, + "",//"sqrl.server:8443",//host + "",//"https://web.server/signin",//referrer + "192.168.1.100",//remoteaddr + "", //"https://web.server",//origin + "8443",//port + &rsp + ); + SSP_InitResponse(&rsp); + SSP_SendRequest(&scb); + PrintResponse(&rsp); + DecodeResponse(&rsp); + SSP_FreeResponse(&rsp); + + +/* + // List DataBase + SetUpSqrlControlBlock( + &scb, + "GET", + "/bdb.sqrl", + "", + 0, + NULL, + "sqrl.server:8443", + "https://web.server/signin", + "192.168.1.100", + "https://web.server", + "8443", + &rsp + ); + SSP_InitResponse(&rsp); + PrintResponse(&rsp); + + SSP_FreeResponse(&rsp); +*/ + SSP_ShutDownSqrlSystem(); + + return 0; +} +#endif diff --git a/SSP-API-Source/utils.c b/SSP-API-Source/utils.c new file mode 100644 index 0000000..be403f8 --- /dev/null +++ b/SSP-API-Source/utils.c @@ -0,0 +1,573 @@ + +// utils.c + +#include "global.h" +#include "blowfish.h" + +/* +=============================================================================== + LOG THE QUERY AND REPLY + Conditionally log the incoming query and our reply +=============================================================================== +*/ +void LogTheQueryAndReply(SQ_CHAR *pszMessage, SQRL_CONTROL_BLOCK *pSCB) { + BEG("LogTheQueryAndReply()"); + SQ_CHAR szQuery[2048]; + + if(bEnableTransactionLogging==SQ_TRUE){ + strcpy(szQuery, pSCB->lpszMethod); + strcat(szQuery, " "); + strcat(szQuery, pSCB->lpszPathInfo); + if(pSCB->lpszQueryString!=NULL){ + strcat(szQuery, "?"); + strcat(szQuery, pSCB->lpszQueryString); + } + strcat(szQuery, "\r\n : "); + strcat(szQuery, pszMessage); + + //[ + //? should we open the file in exclusive share mode + //? or protect it with a critical section? + //] + + FILE *pFile=fopen("SSPAPI.log", "a"); + int MsgLen=strlen(szQuery); + fwrite(szQuery, 1, MsgLen, pFile); + fwrite("\r\n", 1, 2, pFile); + fflush(pFile); + fclose(pFile); + } + END(); +} + +/* +=============================================================================== + GLOBAL ALLOC / GLOBAL FREE / SAFE GLOBAL FREE +------------------------------------------------------------------------------- +*/ +//[ For development to check for allocations not subsequently freed] +static int AllocCount=0; +//] +void *GlobalAlloc(SQ_DWORD NumBytes) { + BEG("GlobalAlloc()"); + void *ptr; + if((ptr=calloc(NumBytes, 1))==NULL) { + perror("sspapi: Out of Memory\r\n"); + exit(1); + } +//[ + LOG("%p", ptr); + AllocCount++; + LOG("[%d]", AllocCount); +//] + END(); + return ptr; +} +void GlobalFree(void **ppGlobalAllocation) { + if(ppGlobalAllocation==NULL || *ppGlobalAllocation==pszNull) { + // The pointer is NULL or to "", not to allocated memory + return; + } + BEG("GlobalFree()"); +//[ + LOG("%p", *ppGlobalAllocation); +//] + if(*ppGlobalAllocation!=NULL) { + free(*ppGlobalAllocation); + *ppGlobalAllocation=NULL; +//[ + AllocCount--; +//] + } +//[ + LOG("[%d]", AllocCount); +//] + END(); +} + +/* +=============================================================================== + CHECK LOCALHOST CALLER + This checks for the IPv6 localhost IP: 2002:7F00:0001:0000:0000:0000:0000:0000 + The status flags are set when we return. We return ZERO (equal) if it's LOCAL +=============================================================================== +*/ +SQ_RCODE CheckLocalhostCaller(SQRL_CONTROL_BLOCK *pSCB) { + BEG("CheckLocalhostCaller()"); + + SQ_BYTE aIPbuffer[IPV6_BYTE_LEN]; // [16] + SQ_BYTE aLocalhost[]={ + 0x20, 0x02, 0x7f, 0x00, 0x00, 0x01, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + + ObtainClientConnectionIP(aIPbuffer, pSCB); + END(); + return (memcmp(aIPbuffer, aLocalhost, IPV6_BYTE_LEN)==0? SQ_PASS: SQ_FAIL); +} + +//------------------------------------------------------------------------------ +void SQ_GetSystemTimeAsFileTime(SQ_QWORD *pFileTime) { + BEG("SQ_GetSystemTimeAsFileTime()"); + // This offset was obtained from the Windows function + // SystemTimeToFileTime(1970-01-01 00:00:00); + // It is the number of 100ns units from + // 1601-01-01 00:00:00 to 1970-01-01 00:00:00 + + SQ_QWORD Offset1601To1970=(SQ_DWORD)0x019db1ded53e8000; + SQ_QWORD TenMillion=(SQ_QWORD)10000000; + SQ_QWORD RawTime=(SQ_QWORD)time(NULL); + + *pFileTime=Offset1601To1970+TenMillion*RawTime; + END(); +} + +//------------------------------------------------------------------------------ +SQ_DWORD SQ_GetFileTimeAgeInMinutes(SQ_QWORD *pSqrlLastActivityDate, SQ_QWORD *pCurrentTime) { + BEG("SQ_GetFiletimeAgeInMinutes()"); + SQ_QWORD SixHundredMillion=(SQ_QWORD)600000000; + SQ_QWORD AgeInMinutes=(*pCurrentTime-*pSqrlLastActivityDate)/SixHundredMillion; + END(); + return (SQ_DWORD)AgeInMinutes; +} +/* +=============================================================================== + GET SYSTEM ONE SECOND TIME + This returns a low-resolution (1 second) time in a single DWORD value. +=============================================================================== +*/ +SQ_DWORD GetSystemOneSecondTime(){ + BEG("GetSystemOneSecondCount()"); + +//? A latent Y2038 bug ??? + + time_t now; + time(&now); + + END(); + return (SQ_DWORD)now; +} + +/* +============================================================================ + GET NEXT MONOTONIC COUNTER VALUE + We give this a pointer to a 8-byte (64-bit) buffer, which it fills +============================================================================ +*/ +SQ_RCODE GetNextMonotonicCounterValue(SQ_BYTE *pNextValue) { + BEG("GetNextMonotonicCounterValue()"); + + // bytes are little-endian + + EnterCriticalSection(&IncDataCriticalSection); + + // Get the current value + SQ_BYTE aValue[BYTES_FOR_64_BITS]; // 8 bytes=64bits + if(Get64BitCounter(aValue)==SQ_FAIL){ + // ERROR + memset(aValue, 0, BYTES_FOR_64_BITS); + } + +LOG("Current monotonic counter value:"); +LOG("[x]", aValue, BYTES_FOR_64_BITS); + + // Increment the counter value + SQ_WORD tmp; + SQ_WORD carry=1; + for(int i=0; i>8); + if(carry==0) break; + } + if(Set64BitCounter(aValue)==SQ_FAIL){ + // ERROR + } + + memcpy(pNextValue, aValue, BYTES_FOR_64_BITS); + + LeaveCriticalSection(&IncDataCriticalSection); + END(); + return SQ_PASS; +} + +/* +=============================================================================== + GET UNPREDICTABLE 64 BITS +=============================================================================== +*/ +void GetUnpredictable64bits(SQ_BYTE *p64bitBuffer) { + BEG("GetUnpredictable64bits()"); + + // this byte array is little-endian + // retrieve a 64-bit monotonic counter value... + if(GetNextMonotonicCounterValue(p64bitBuffer)==SQ_FAIL) { + // ERROR: Cannot get next counter value +//[ +LOG("Error:%s %d", __FILE__, __LINE__); +//] + } + // which we then encrypt (in place) + blowfish_context_t *ctx = (blowfish_context_t *)GlobalAlloc(sizeof(blowfish_context_t)); + blowfish_initiate(ctx, aSystemKey, BLOWFISH_KEY_LEN); + + // separate the high 4 and low 4 bytes + blowfish_encryptblock(ctx, (BF_ULONG *)(&p64bitBuffer[4]), (BF_ULONG *)(&p64bitBuffer[0])); + + blowfish_clean(ctx); + GlobalFree((void **)&ctx); + + END(); +} +/* +=============================================================================== + GET UNIQUE 12 CHAR NUT + ------------------------------------------------------------------------------ + Given a pointer to a 12 or 13-character buffer, this fills it with + a unique 72-bit pseudo-random value encoded into Base64url. +------------------------------------------------------------------------------- +*/ +void GetUnique12charNut(SQ_CHAR *pszBase64Buffer, SQ_BOOL NullTerm) { + BEG("GetUnique12charNut()"); + + const int CtrLen=BYTES_FOR_64_BITS+1; // 9 bytes, 72 bits + const int BufLen=SQRL_NUT_LEN; // 12 encoded characters + + SQ_BYTE aEncryptedCounter[CtrLen]; + + // retrieve a 64-bit monotonic counter value which we then encrypt + GetUnpredictable64bits(aEncryptedCounter); + // add a byte of high entropy clock ticks + aEncryptedCounter[CtrLen-1]=(SQ_BYTE)(clock()&0xff); +//[ +// If counter was reset for testing don't let this byte change +if(bCounterReset==SQ_TRUE) aEncryptedCounter[CtrLen-1]=0x00; +//] + +//[ +LOG("aEncryptedCounter:"); +LOG("[x]", aEncryptedCounter, CtrLen); +//] + // encode our pseudo-random number + SqrlCvrtToBase64(pszBase64Buffer, BufLen, aEncryptedCounter, CtrLen); + + // null-terminate if requested (pszBase64Buffer size must be BufLen+1) + if(NullTerm) pszBase64Buffer[BufLen]='\0'; +//[ +LOG("pszBase64Buffer:"); +LOG("[c]", pszBase64Buffer, BufLen); +//] + END(); +} +/* +=============================================================================== + GET UNIQUE 20 DIGIT TOKEN + ------------------------------------------------------------------------------ + Given a pointer to a 20-character buffer, this fills the buffer with a + unique 20-digit decimal number. It performs 20 rounds of long division of + a 128-bit guaranteed unique binary number +------------------------------------------------------------------------------- +*/ +void GetUnique20digitToken(SQ_CHAR *p20CharBuffer, SQ_BOOL NullTerm) { + BEG("GetUnique20digitToken()"); + + // retrieve a unique 64-bit pseudo-random value which we decimalize + SQ_BYTE Entropy[16]; // 128 bits (treated as little-endian) + GetUnpredictable64bits(&Entropy[0]); + GetUnpredictable64bits(&Entropy[8]); + + SQ_DWORD ByteNdx; + SQ_DWORD CharNdx=20; + SQ_QWORD Q[1]; // The 64-bit accumulator + SQ_QWORD *pQ=&Q[0]; + SQ_DWORD *pLo=&((SQ_DWORD *)Q)[0]; + SQ_DWORD *pHi=&((SQ_DWORD *)Q)[1]; + + do { + CharNdx--; + *pHi=0; + ByteNdx=4; + do { + ByteNdx--; + *pLo=((SQ_DWORD *)Entropy)[ByteNdx]; + SQ_DWORD lo=*pQ/10; + SQ_DWORD hi=*pQ%10; + *pLo=lo; + *pHi=hi; + ((SQ_DWORD *)Entropy)[ByteNdx]=*pLo; + } while(ByteNdx>0); + p20CharBuffer[CharNdx]=*pHi+'0'; + } while(CharNdx>0); + + if(NullTerm==SQ_TRUE) { + p20CharBuffer[20]='\0'; + } + LOG("[]", p20CharBuffer, 20); + END(); +} +//------------------------------------------------------------------------------ +void IPv4StringToAddress(char *pIPaddress, void *pBuffer, unsigned int *pBufferLength) { + BEG("IPv4StringToAddress()"); + + // The address bytes are stored in big-endian format + // We expect the string to be a valid ip so we just use sscanf() + // and return all zeros if there is an error + + // The IP4 conversion produces 4 bytes + const int NumBytes=4; + if(*pBufferLength>=NumBytes) { + // We need a temporary array of ints for sscanf() + int tmp[NumBytes]; + if(sscanf(pIPaddress, "%d.%d.%d.%d", &tmp[0], &tmp[1], &tmp[2], &tmp[3])==NumBytes) { + // Copy bytes (value 0x00-0xff) into the buffer + SQ_BYTE *p=(SQ_BYTE *)pBuffer; + for(int i=0; i=NumBytes) { + // We need a temporary array of ints for sscanf() + int tmp[NumWords]; + if(sscanf(pIPaddress, "%x:%x:%x:%x:%x:%x:%x:%x", + &tmp[0], &tmp[1], &tmp[2], &tmp[3], &tmp[4], &tmp[5], &tmp[6], &tmp[7])==NumWords) { + // Copy words (value 0x0000-0xffff) into the buffer + SQ_BYTE *p=(SQ_BYTE *)pBuffer; + for(int i=0; i>8); + p[i*2+1]=(SQ_BYTE)(tmp[i]&0xff); + } + *pBufferLength=NumBytes; + END(); + return; + } + } + // Otherwise there is an error + memset(pBuffer, 0, *pBufferLength); + *pBufferLength=0; + END(); +} + +/* +=============================================================================== + OBTAIN CLIENT CONNECTION IP +------------------------------------------------------------------------------- + This obtains the client's connection IP with IPv4 & IPv6 compatibility. If the + server returns an IP string containing a ':' we treat it as an IPv6 address. + If ':' is not present, we treat it as an IPv4 address. In that case we create + a 128-bit IPv6 style address "2002:xxxx:xxxx:0000:0000:0000:0000:0000. +=============================================================================== +*/ +void ObtainClientConnectionIP(void *pIPbuffer, SQRL_CONTROL_BLOCK *pSCB) { + BEG("ObtainClientConnectionIP()"); + + // IP address bytes are stored in big-endian order +//* SQ_CHAR szIPaddress[64]; + SQ_DWORD BufferLength; + SQ_BYTE aIPv4SockAddr[4]; // xx.xx.xx.xx + SQ_WORD aIPv6SockAddr[8]; // xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx + + // we may have an IPv4 address (aa.bb.cc.dd), so we preload the 6to4 + // "2002:" mapping in case we need to plug an IPv4 format address into + // IPv6 address space: 2002:aabb:ccdd:0000:0000:0000:0000:0000 + + memset(aIPv6SockAddr, 0, IPV6_BYTE_LEN); + aIPv6SockAddr[0]=0x0220; // 2002:0000:0000:0000:0000:0000:0000:0000 + + // we need to determine whether we received an IPv4 or IPv6 address + if(strstr(pSCB->lpszRemoteAddr, ":")!=NULL) { + // we DID find an ':' in the address string, so it's IPv6 + // but is it "::1" which is our localhost loopback IPv6 IP? + if(strcmp(pSCB->lpszRemoteAddr, "::1")==0) { + aIPv6SockAddr[1]|=0x007f; // 2002:7f00:0000:0000:0000:0000:0000:0000 + aIPv6SockAddr[2]|=0x0100; // 2002:7f00:0001:0000:0000:0000:0000:0000 + memcpy(pIPbuffer, aIPv6SockAddr, IPV6_BYTE_LEN); + + END(); + return; + } + + BufferLength=sizeof(aIPv6SockAddr); + IPv6StringToAddress(pSCB->lpszRemoteAddr, aIPv6SockAddr, &BufferLength); + } + else { + // we have an IPv4 address (aa.bb.cc.dd) so let's plug-in its 32-bits + BufferLength=sizeof(aIPv4SockAddr); + IPv4StringToAddress(pSCB->lpszRemoteAddr, aIPv4SockAddr, &BufferLength); + aIPv6SockAddr[1]|=((SQ_WORD *)aIPv4SockAddr)[0]; // 2002:aabb:0000:0000:0000:0000:0000:0000 + aIPv6SockAddr[2]|=((SQ_WORD *)aIPv4SockAddr)[1]; // 2002:aabb:ccdd:0000:0000:0000:0000:0000 + } + // return the final 128-bit (16-byte) IPv6 format address + memcpy(pIPbuffer, aIPv6SockAddr, IPV6_BYTE_LEN); + + LOG("aIPv4SockAddr (dec):"); + LOG("[d]", aIPv4SockAddr, IPV4_BYTE_LEN); + LOG("aIPv6SockAddr: (dec):"); + LOG("[d]", aIPv6SockAddr, IPV6_BYTE_LEN); + + END(); +} + +/*=============================================================================== + VERIFY PRIVATE QUERY + This verifies that our client's requesting hostname and port are correct for + access to the private SSP API functions. We return NOT ZERO if they are wrong. +=============================================================================== +*/ +SQ_RCODE VerifyPrivateQuery(SQRL_CONTROL_BLOCK *pSCB) { + BEG("VerifyPrivateQuery()"); + + SQ_CHAR szLogError[512]; + + if(szPrivateAccessIp[0]=='?') { + // Private Access IP has not been specified in the sspapi.cfg file + // Assume this first query is from our private access ip + SetCfgItem(CFG_PRIVATE_ACCESS_IP, pSCB->lpszRemoteAddr); + } + + // let's first check the port the user is calling since that's the most + // likely to be incorrect for innocent mis-queries to the private APIs. +// if(strcmp(pSCB->szServerPort, szPrivatePort)!=0) { + if(strcmp(pSCB->szServerPort, szListenPort)!=0) { + END(); + return SQ_FAIL; + } + //we DO have the proper port number, so do we have a wildcard query IP? + if(szPrivateAccessIp[0]=='*') { + END(); + return SQ_PASS; + } + // if the caller is local, then we know it's okay + if(CheckLocalhostCaller(pSCB)==SQ_PASS) { + END(); + return SQ_PASS; + } + // it's the correct port, and it's not a LocalHost query. + // so let's see whether it's a valid non-localhost IP? + +//[ +//. Why strstr() and not strcmp() ? +//] + if(strstr(szPrivateAccessIp, pSCB->lpszRemoteAddr)==NULL) { + // if an attempt was made to access the private query from + // a non-registered IP, let's make a log entry... + sprintf(szLogError, pszBlockedPrivateQuery, pSCB->lpszRemoteAddr); + LogTheQueryAndReply(szLogError, pSCB); + END(); + return SQ_FAIL; + } + + END(); + return SQ_PASS; +} + +/* +============================================================================ + URL ENCODE +---------------------------------------------------------------------------- +*/ +SQ_BYTE UrlEncodeTable[]={ +// 0 1 +// 0 1 2 3 4 5 6 7 8 9 a b c d e f 0 1 2 3 4 5 6 7 8 9 a b c d e f + 0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, + +// 2 3 +// 0 1 2 3 4 5 6 7 8 9 a b c d e f 0 1 2 3 4 5 6 7 8 9 a b c d e f +// sp " # $ % & + , / : ; < = > ? + 1,0,1,1,1,1,1,0,0,0,0,1,1,0,0,1,0,0,0,0,0,0,0,0,0,0,1,1,1,1,1,1, + +// 4 5 +// 0 1 2 3 4 5 6 7 8 9 a b c d e f 0 1 2 3 4 5 6 7 8 9 a b c d e f +// @ [ \ ] ^ + 1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,0, + +// 6 7 +// 0 1 2 3 4 5 6 7 8 9 a b c d e f 0 1 2 3 4 5 6 7 8 9 a b c d e f +// ~ } | { ` + 1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,1,1,1,0 +// ` { | } ~ +}; + +// Note: The size of the destination buffer must be at least +// strlen(pSrcBuffer)*3+1 to avoid possible overruns + +void UrlEncode(SQ_CHAR *pDstBuffer, SQ_CHAR *pSrcBuffer) { + BEG(""); + + // Source and destination indices + int SrcNdx=0; + int DstNdx=0; + int c; + do { + // Check if the character needs to be encoded as %hex + c=(int)((unsigned char)pSrcBuffer[SrcNdx++]); + if(UrlEncodeTable[c]==0) { + // no, copy directly + pDstBuffer[DstNdx++]=c; + } + else { + // yes, convert to %hex + pDstBuffer[DstNdx++]='%'; + pDstBuffer[DstNdx++]=(char)NybbleToHex(c>>4); + pDstBuffer[DstNdx++]=(char)NybbleToHex(c&0x0f); + } + } while(c!='\0'); + END(); +} + +/* +=============================================================================== + PLACE CPS URL INTO BUFFER + in: pCPSNonce + out pBuffer +=============================================================================== +*/ +void PlaceCpsUrlIntoBuffer(SQ_CHAR *pBuffer, PENDING_AUTHS *pPendingAuth) { + BEG("PlaceCpsUrlIntoBuffer()"); + SQ_CHAR szCPSNonce[28]; + + // we check for any path extension "x=n" (n is at offset 2) + char PathExt=pPendingAuth->szPathExtension[2]; // null or '0' to '9' + int ndx=0; + if(PathExt>='1' && PathExt<='9') { + ndx=PathExt-'0'; + + // If there is no URL for that path extension, just use the primary URL + if(strlen(szWebServerAuthUrlArray[ndx])==0) { + ndx=0; +//[ +char sPathExt[]="x=?"; +memcpy(sPathExt, pPendingAuth->szPathExtension, 3); +LOG("Warning: No Auth URL for Path Extension %s", sPathExt); +//] + } + } + memcpy(szCPSNonce, pPendingAuth->aCPSNonce, CPS_TOKEN_LEN); + szCPSNonce[CPS_TOKEN_LEN]='\0'; + sprintf(pBuffer, "%s?%s", szWebServerAuthUrlArray[ndx], szCPSNonce); +//[ +if(PathExt<'0' || PathExt>'9') {PathExt='-';} +LOG("PathExt: %c, Auth URL[%d]: %s, CPSNonce: %s", +PathExt, ndx, szWebServerAuthUrlArray[ndx], szCPSNonce); +//] + END(); +} diff --git a/install.html b/install.html new file mode 100644 index 0000000..06b9f44 --- /dev/null +++ b/install.html @@ -0,0 +1,446 @@ + + + + + +

+ SQRL
+
+ Installation of SSP API for Linux
+ SSP-API-Linux-07.tar.xz
+  
+ SSP API reference: https://www.grc.com/sqrl/sspapi.htm
+

+ The SSP API library presented here is a translation of GRC's + MASM/Windows implementation of the SSP API.  The following + installation procedure is based on a fresh minimal installation + of 64-bit Linux Ubuntu version 18.04.3 LTS obtained from + https://www.ubuntu.com/download/desktop + .
+
+ After Ubuntu is installed, the bash script, install.sh, + automates most of the SSP API installation.  XAMPP is + installed to provide a simple implementation of the SSP API.  + Step by step instructions are also provided below.
+
+ Package Contents: (download the .tar.xz file to the downloads + folder and run tar -xf SSP*.xz ).
+
+ Folders: Blowfish-Source, Lodepng-Source, + PHP-EXT-Source, SSP-API-Demo, SSP-API-Source
+ Files: install.html, install.sh
+
+ Note: The script uses variables for the download and desktop + folder names so they can be changed if necessary.
+ In this procedure they are referred to by their default + locations ~/Downloads and ~/Desktop .
+
+ The installation script needs to know the latest versions of the + third-party software it installs.  It defaults to the versions + available at the time it was last revised which are listed here + followed by the web sites where the current version numbers can + be found:
+
+ db-18.1.32.tar.gz  https://www.oracle.com/technetwork/database/database-technologies/berkeleydb/downloads ***
+
+ libsodium-1.0.18-stable.tar.gz  https://download.libsodium.org/libsodium/releases
+ mbedtls-2.16.3-apache.tgz  https://tls.mbed.org/download
+ openssl-1.1.1d.tar.gz  https://www.openssl.org/source
+ qrencode-4.0.2.tar.gz  https://fukuchi.org/works/qrencode
+ xampp-linux-x64-7.3.11-0-installer.run  http://www.apachefriends.org
+
+ *** Note: To obtain the Berkeley database you will need to + register with Oracle
+ *** then download the file manually.  Do that before + running the install script.
+ *** The install script will download the other files itself.
+
+ Open the Downloads folder in a terminal and enter the + following commands:
+ chmod +x install.sh
+ ./install.sh
+
+ This provides basic instructions.  You can right-click on + each URL displayed in the terminal window and select Open + Link to go to the  web page and determine the latest + available version number (or click on the links above in this + document).
+
+ To install using the defaults run ./install.sh --default
+ To specify file versions run, for example, ./install.sh  + 18.1.32  1.0.18  2.16.3  1.1.1d  4.0.2  7.3.11-0
+ or edit install.sh and change the defaults.
+  
+ If you do not want to run the script, follow steps 1 to 20 + below.
+
+ If you run the script, note that you will be prompted to edit + three files: php.ini, .sspapi.cfg and hosts.  + When the script is finished follow steps 14 to 20.
+
+

+ Most commands are entered in a terminal window.  Some steps are + done in the file manager (Nautilus).  Downloaded files are + assumed to be in the ~/Downloads folder.  The reader is assumed + to have a basic knowledge of Linux (for the server) and Windows + (for the client).
+
+ 1. gcc, make, and net-tools
+
+ To install enter the commands:
+ sudo apt install gcc
+ sudo apt install make
+ sudo apt install net-tools
+ sudo apt install autoconf
+
+ 2. Berkeley Database library
+
+ Download from: https://www.oracle.com/technetwork/database/database-technologies/berkeleydb/downloads
+ Select Berkeley DB 18.1.32.tar.gz (or the latest + version)
+ Open the downloaded file and extract its contents to ~/Downloads/db-18.1.32
+ Navigate to the build-unix folder, open a terminal there + and enter the commands:
+ ../dist/configure
+ make
+ sudo make install
+ sudo cp -P /usr/local/BerkeleyDB.18.1/lib/libdb*.so + /usr/local/lib
+ sudo cp /usr/local/BerkeleyDB.18.1/include/db.h + /usr/local/include
+
+ 3. Libsodium library
+
+ Download from https://download.libsodium.org/libsodium/release
+ Select libsodium-1.0.18-stable.tar.gz (or the latest + version)
+ Open the downloaded file and extract its contents to ~/Downloads/libsodium-stable
+ Open the folder libsodium-stable in a terminal and + enter the commands:
+ ./configure --disable-dependency-tracking
+ make
+ #make check
+ sudo make install
+
+ 4. MBedTLS library
+
+ Download from https://tls.mbed.org/download
+ Select mbedtls-2.16.3-apache.tgz (or the latest version)
+ Open the downloaded file and extract its contents to ~/Downloads/mbedtls-2.16.3
+ Open the folder mbedtls-2.16.3 in a terminal and enter + the commands:
+ make no_test CFLAGS='-O2 -fPIC -DMBEDTLS_THREADING_PTHREAD + -DMBEDTLS_THREADING_C'
+ sudo make install
+ cd /usr/local/lib
+ sudo gcc -shared -o libmbed.so -Wl,-whole-archive -lmbedcrypto + -lmbedtls -lmbedx509 -Wl,-no-whole-archive
+ sudo ldconfig
+ cd ~/Downloads
+  
+ 5. OpenSSL library
+
+ Download from https://www.openssl.org/source
+ Select openssl-1.1.1d.tar.gz
+ Open the downloaded file and extract its contents to ~/Downloads/openssl-1.1.1d
+ Open the folder openssl-1.1.1d  in a terminal and + enter the commands:
+ ./config
+ make
+ #make test
+ sudo make install
+
+ 6. QR Encode library
+
+ Download from https://fukuchi.org/works/qrencode
+ Select qrencode-4.0.2.tar.gz
+ Open the downloaded file and extract its contents to ~/Downloads/qrencode-4.0.2
+ Open the folder qrencode-4.0.2 in a terminal and + enter the commands:
+ ./configure --without-tools
+ make
+ sudo make install
+ sudo ldconfig
+
+ 7. XAMPP for Linux
+
+ Download from https:www.apachefriends.org/download.html
+ Select xampp-linux-x64-7.3.11-0-installer.run
+ Open the Downloads folder in a terminal and enter the + commands:
+ chmod +x xampp-linux-x64-7.3.11-0-installer.run
+ sudo ./xampp-linux-x64-7.3.11-0-installer.run
+
+ Install XAMPP using its Setup Wizard.  Do not launch XAMPP when + it is finished.
+
+ 8. Blowfish library
+
+ Open the folder Blowfish-Source in a terminal and enter + the command
+ make
+
+ 9. Lodepng library
+
+ Open the folder Lodepng-Source in a terminal and enter + the command
+ make
+
+ 10. SSP-API-Source
+
+ Open the folder SSP-API-Source in a terminal and enter + the command:
+ make
+
+ 11. PHP Extension
+
+ Open the folder PHP-EXT-Source in a terminal and + enter the commands:
+ /opt/lampp/bin/phpize
+ ./configure --enable-sspphp + --with-php-config=/opt/lampp/bin/php-config
+ sudo make install
+
+ Edit the file php.ini :
+ sudo nano -c /opt/lampp/etc/php.ini
+ Locate the section on Dynamic Extensions (~ line 925)
+ Add the line extension=sspphp.so
+
+ 12. SSP-API-DEMO
+
+ Open the folder SSP-API-Demo in a terminal and run the + following commands:
+ mkdir ~/Desktop/SSP-API-Demo
+ cp ~/Downloads/SSP-API-Source/ssphttp + ~/Desktop/SSP-API-Demo
+ cp ~/Downloads/SSP-API-Source/sspfunc + ~/Desktop/SSP-API-Demo
+ cp ~/Downloads/SSP-API-Demo/.sspapi.cfg + ~/Desktop/SSP-API-Demo
+ cp ~/Downloads/SSP-API-Demo/ssp.server.crt + ~/Desktop/SSP-API-Demo
+ cp ~/Downloads/SSP-API-Demo/ssp.server.key + ~/Desktop/SSP-API-Demo
+ cp ~/Downloads/SSP-API-Demo/DebugFilter.txt + ~/Desktop/SSP-API-Demo
+ cp ~/Downloads/SSP-API-Demo/rx.sh ~/Desktop/SSP-API-Demo
+ cp ~/Downloads/SSP-API-Demo/rh.sh ~/Desktop/SSP-API-Demo
+ cp ~/Downloads/SSP-API-Demo/rf.sh ~/Desktop/SSP-API-Demo
+ chmod +x ~/Desktop/SSP-API-Demo/rh.sh
+ chmod +x ~/Desktop/SSP-API-Demo/rf.sh
+ chmod +x ~/Desktop/SSP-API-Demo/rx.sh
+
+ sudo mv /opt/lampp/etc/ssl.crt/server.crt + /opt/lampp/etc/ssl.crt/server.crt.old
+ sudo ln -s ~/Downloads/SSP-API-Demo/web.server.crt + /opt/lampp/etc/ssl.crt/server.crt
+ sudo mv /opt/lampp/etc/ssl.key/server.key + /opt/lampp/etc/ssl.key/server.key.old
+ sudo ln -s ~/Downloads/SSP-API-Demo/web.server.key + /opt/lampp/etc/ssl.key/server.key
+ sudo mkdir /opt/lampp/htdocs/sqrl
+ sudo ln -s ~/Downloads/SSP-API-Demo/sqrl.index.php + /opt/lampp/htdocs/sqrl/index.php
+ sudo mkdir /opt/lampp/htdocs/auth
+ sudo ln -s ~/Downloads/SSP-API-Demo/auth.index.php + /opt/lampp/htdocs/auth/index.php
+ sudo mkdir /opt/lampp/htdocs/test
+ sudo ln -s ~/Downloads/SSP-API-Demo/test.index.php + /opt/lampp/htdocs/test/index.php
+ sudo cp ~/Downloads/SSP-API-Demo/.sspapi.cfg + /opt/lampp/htdocs/test
+ sudo cp ~/Downloads/SSP-API-Demo/DebugFilter.txt + /opt/lampp/htdocs/test
+ sudo chmod a+w -R /opt/lampp/htdocs/test
+
+ 13. Customize with the Server ip address
+
+ Run hostname -I to determine the local ip address
+ Make a note of this address.  It will be referred to as <server-ip> +
+
+ Edit the SSP API configuration file
+ nano ~/Desktop/SSP-API-Demo/.sspapi.cfg
+
+ Choose the handler you want by "commenting out" with a # + the other e.g.
+ #HandlerName=MBedTLS
+ HandlerName=OpenSSL
+
+ In the line ListenIP=<ssp-server-ip> replace <ssp-server-ip> + with your <server-ip>
+ In the line PrivateAccess=<web-server-ip> + replace <web-server-ip> with your <server-ip>
+  
+ Edit the hosts file with the command:
+ sudo nano /etc/hosts
+
+ +
Add these two lines:
+ <server-ip> ssp.server
+ <server-ip> web.server
+
+

+ 14.  Open the SSP-API-Demo folder on the Desktop in a + terminal.
+ Enter the command ./rh.sh
+
+ This starts XAMPP and initializes the SSP-API.  The code is in + sspmain.c under #ifdef HTTP_INTERFACE.
+
+ Some information should be displayed ending with
+ [ MBedTLS ] Waiting for a remote connection (for + MBedTLS)
+ or
+ Listen URL: https://[<ip address>]:8443 (for + OpenSSL)
+
+ Open Firefox and go to https://ssp.server:8443/png.sqrl
+ Allow an exception for the self-signed certificate.
+ You should receive a QR code
+
+ Go to https://web.server/sqrl
+ Allow an exception for the self-signed certificate.
+ You should see a SQRL Sign In page
+
+ In order to sign in using GRC's sqrl.exe client you need to + run it under Windows.
+
+ 15. On the Windows Computer: Edit the HOSTS file
+
+ Edit the Window HOSTS file
+ C:\Windows\System32\Drivers\etc\HOSTS
+
+ Add these two lines, replacing <server-ip> + with the same ip address obtained previously with hostname
+ <server-ip> ssp.server
+ <server-ip> web.server
+
+ 16. On the Windows Computer:  Register the self-signed + certificates
+
+ Copy ssp.server.crt and web.server.crt from + the Ubuntu Downloads/SSP-API-Demo folder to a USB + flash drive or otherwise make them available to Windows.
+
+ These steps are from Windows 7.
+ Run mmc from the Start Menu or a Command Prompt
+ From the File menu, select Add/Remove Snap-in
+ Select Certificates and click Add, select My + user account, click Finish, click OK
+ Double-click on Certificates - Current User
+ Right-click on Trusted Root Certification Authorities, + select All Tasks -> Import
+ At the Import Wizard click Next
+ Click Browse and locate ssp.server.crt, click + Open
+ Click Next
+ Select Place all certificates in the following store
+  Trusted Root Certificate Authorities
+ Click Next
+ Click Finish
+ For the Security Warning click Yes
+ For The import was successful, click OK
+
+ Repeat for web.server.crt
+
+ Close the application and click Yes to Save console + settings to Console1?
+
+ 17. On the Windows Computer:
+
+ Make sure the sqrl.exe client is installed.  Open a + browser and enter https://ssp.server:8443/png.sqrl.  + Depending on the browser you may get a message warning about + the self-signed certificate.  Allow the browser to continue.  + You should get a QR code image.
+
+ Close the web page and enter https://web.server/sqrl.  + Accept any warning.  You should get a  page with a Sign In + with SQRL button, a QR code and other buttons.
+
+ Click on Sign In with SQRL and enter your SQRL + password.  The web server should reply with the contents of + the PHP $_SERVER array (just for information) and end with responses + to /cps.sqrl and /add.sqrl response of the form
+
+ user=KRAreP6ouLlN&stat=&name=aHR0cHM6Ly93ZWIuc2VydmVyL3Nxcmwv&acct=TestAccount
+ and
+ user=KRAreP6ouLlN&acct=TestAccount&name=user-name&stat=&invt=
+
+ Return to https://web.server/sqrl + click on Shut Down and return to the Linux + Computer
+
+ 18. The Function Interface
+
+ Enter the command ./rf.sh This calls the SSP-API + library functions for initialization, nut.sqrl and png.sqrl + directly instead of through http.  The code is in sspmain.c + under #ifdef FUNC_INTERFACE
+
+ 19. The PHP Extension
+
+ In Firefox go to https://web.server/test + The index.php file sends nut.sqrl and png.sqrl commands to the + SSP-API library using the PHP extension ssphp.c and displays a + variety of information for development purposes.
+
+ The command ./rx.sh stops and restarts the XAMPP + server.
+
+ 20. Installing the SSP API as a service (example)
+
+ If you wish to run the SSP API as a service, create this file:
+ /lib/systemd/system/sspapi.service
+ Containing (replace <user> with your username):
+
+ [Unit]
+ Description=SSP API Server
+ Requires=network-online.target
+ After=network-online.target
+
+ [Service]
+ Type=simple
+ WorkingDirectory=/home/<user>/Desktop/SSP-API-Demo
+ ExecStart=/home/<user>/Desktop/SSP-API-Demo/ssphttp
+ StandardOutput=file:/home/<user>/Desktop/SSP-API-Demo/stdout.txt
+ StandardError=file:/home/<user>/Desktop/SSP-API-Demo/stderr.txt
+
+ [Install]
+ WantedBy=multi-user.target
+
+ Useful Commands:
+ systemctl enable sspapi
+ systemctl disable sspapi
+ systemctl start sspapi
+ systemctl stop sspapi
+ systemctl status sspapi
+
+
+
+
+ + diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..a9fdced --- /dev/null +++ b/install.sh @@ -0,0 +1,355 @@ +#!/bin/bash + +#Default third-party file versions for: +#BerkeleyDB, Libsodium, MBedTLS, OpenSSL, QRencode, XAMPP + +DBV='18.1.32' +LSV='1.0.18' +MBV='2.16.3' +OSV='1.1.1d' +QRV='4.0.2' +XAV='7.3.11-0' + +DOWNLOADS=~/Downloads +DESKTOP=~/Desktop +EDITOR="sudo gnome-terminal -- nano -c" + +function pause(){ + read -p "$*" +} + +if [ $# -eq 1 ] && [ $1 == --default ]; then +echo 'Using default file versions:' +else +if [ $# -eq 1 ] && [ $1 == --clean-ssp ]; then +echo 'Preparing for re-building ssp-api (third party files are not deleted):' +mkdir ~tmp~ +mv *.*z ~tmp~ +sudo rm -r SSP-API-Demo +sudo rm -r SSP-API-Source +mv ~tmp~/*.*z . +rmdir ~tmp~ +sudo rm -r ~/Desktop/SSP-API-Demo +sudo rm /usr/local/lib/libsspapi.* +tar -xf SSP-API-Linux-*.tar.xz +sudo chmod +x install.sh +exit +else +if [ $# -eq 1 ] && [ $1 == --clean-all ]; then +echo 'Preparing for re-installation (downloads are not deleted):' +mkdir ~tmp~ +mv *.*z ~tmp~ +sudo rm -r Blowfish-Source +sudo rm -r Lodepng-Source +sudo rm -r PHP-EXT-Source +sudo rm -r SSP-API-Demo +sudo rm -r SSP-API-Source +sudo rm -r db-* +sudo rm -r libsodium-* +sudo rm -r mbedtls-* +sudo rm -r openssl-* +sudo rm -r qrencode-* +mv ~tmp~/*.*z . +rmdir ~tmp~ +sudo rm -r ~/Desktop/SSP-API-Demo +sudo rm /usr/local/lib/lib* +tar -xf SSP-API-Linux-*.tar.xz +sudo chmod +x install.sh +exit +else +if [ $# -eq 6 ]; then +DBV=$1 +LSV=$2 +MBV=$3 +OSV=$4 +QRV=$5 +XAV=$6 +else +echo +echo 'Read install.html for installation instructions' +echo +echo 'To install the file versions available at the last revision of this script enter:' +echo ./install.sh --default +echo +echo 'The defaults are:' +echo db-${DBV}.tar.gz +echo libsodium-${LSV}-stable.tar.gz +echo mbedtls-${MBV}-apache.tgz +echo openssl-${OSV}.tar.gz +echo qrencode-${QRV}.tar.gz +echo xampp-linux-x64-${XAV}-installer.run +echo +echo 'The websites to check for the latest versions are:' +echo https://www.oracle.com/technetwork/database/database-technologies/berkeleydb/downloads +echo https://download.libsodium.org/libsodium/releases +echo https://tls.mbed.org/download +echo https://www.openssl.org/source +echo https://fukuchi.org/works/qrencode +echo https://www.apachefriends.org +echo +echo 'To install newer versions, edit this file or specify all version numbers as parameters, for example:' +echo ./install.sh ${DBV} ${LSV} ${MBV} ${OSV} ${QRV} ${XAV} +echo +echo 'The Berkeley database requires registration and manual download of the installation file' +echo +exit +fi +fi +fi +fi + +# Downloaded file names +DBZ=db-$DBV.tar.gz +LSZ=libsodium-$LSV-stable.tar.gz +MBZ=mbedtls-$MBV-apache.tgz +OSZ=openssl-$OSV.tar.gz +QRZ=qrencode-$QRV.tar.gz +XAZ=xampp-linux-x64-$XAV-installer.run + +# Folder names +DB=db-$DBV +LS=libsodium-stable +MB=mbedtls-$MBV +OS=openssl-$OSV +QR=qrencode-$QRV +XA=$XAZ + +echo 'File versions being sought:' +echo +echo $DBZ +echo $LSZ +echo $MBZ +echo $QRZ +echo $XAZ +echo + +echo 'Installing gcc and make' +echo +if [ ! -e /usr/bin/gcc ]; then sudo apt install gcc; fi +if [ ! -e /usr/bin/make ]; then sudo apt install make; fi +if [ ! -e /bin/netstat ]; then sudo apt install net-tools; fi +if [ ! -e /usr/share/autoconf ]; then sudo apt install autoconf; fi +echo + +echo 'Downloading and extracting Files:' +echo +#OPT=--no-check-certificates +OPT=--ca-directory=/etc/ssl/certs +if [ ! -e ${DBZ} ]; then echo Berkeley Database has not been downloaded; exit; fi +if [ -e ${DBZ} ] && [ ! -e ${DB} ]; then tar xvzf ${DBZ}; fi + +if [ ! -e ${LSZ} ]; then wget ${OPT} https://download.libsodium.org/libsodium/releases/${LSZ}; fi +if [ ! -e ${LSZ} ]; then echo ${LSZ} has not been downloaded; exit; fi +if [ -e ${LSZ} ] && [ ! -e ${LS} ]; then tar xvzf ${LSZ}; fi + +if [ ! -e ${MBZ} ]; then wget ${OPT} https://tls.mbed.org/download/${MBZ}; fi +if [ ! -e ${MBZ} ]; then echo ${MBZ} has not been downloaded; exit; fi +if [ -e ${MBZ} ] && [ ! -e ${MB} ]; then tar xvzf ${MBZ}; fi + +if [ ! -e ${OSZ} ]; then wget ${OPT} https://www.openssl.org/source/${OSZ}; fi +if [ ! -e ${OSZ} ]; then echo ${OSZ} has not been downloaded; exit; fi +if [ -e ${OSZ} ] && [ ! -e ${OS} ]; then tar xvzf ${OSZ}; fi + +if [ ! -e ${QRZ} ]; then wget ${OPT} https://fukuchi.org/works/qrencode/${QRZ}; fi +if [ ! -e ${QRZ} ]; then echo ${QRZ} has not been downloaded; exit; fi +if [ -e ${QRZ} ] && [ ! -e ${QR} ]; then tar xvzf ${QRZ}; fi + +if [ ! -e ${XAZ} ]; then wget ${OPT} https://www.apachefriends.org/xampp-files/${XAV/%-*/}/xampp-linux-x64-${XAV}-installer.run; fi +if [ ! -e ${XAZ} ]; then echo ${XAZ} has not been downloaded; exit; fi + +echo Compiling and installing files: +echo +echo ${DB} +if [ ! -e /usr/local/lib/libdb.so ]; then +cd ${DOWNLOADS}/${DB}/build_unix +../dist/configure +make +sudo make install +sudo find /usr/local/Berkeley* -name libdb*.so -exec cp -P {} /usr/local/lib \; +sudo find /usr/local/Berkeley* -name db.h -exec cp {} /usr/local/include \; +echo +fi + +echo ${LS} +if [ ! -e /usr/local/lib/libsodium.so ]; then +cd ${DOWNLOADS}/${LS} +./configure --disable-dependency-tracking +make +#make check +sudo make install +echo +fi + +echo ${MB} +if [ ! -e /usr/local/lib/libmbed.so ]; then +echo +cd ${DOWNLOADS}/${MB} +make no_test CFLAGS='-O2 -fPIC -DMBEDTLS_THREADING_PTHREAD -DMBEDTLS_THREADING_C' +sudo make install +cd /usr/local/lib +sudo gcc -shared -o libmbed.so -Wl,-whole-archive -lmbedcrypto -lmbedtls -lmbedx509 -Wl,-no-whole-archive +echo +fi + +echo ${OS} +if [ ! -e /usr/local/lib/libssl.so ]; then +echo +cd ${DOWNLOADS}/${OS} +./config +make +#make test +sudo make install +echo +fi + +echo ${QR} +if [ ! -e /usr/local/lib/libqrencode.so ]; then +cd ${DOWNLOADS}/${QR} +./configure --without-tools +make +sudo make install +echo +fi + +echo ${XA} +cd ${DOWNLOADS} +if [ ! -x ${XAZ} ]; then +echo +echo '*****************************************************' +echo 'Install XAMPP using its Setup Wizard' +echo 'Uncheck "Launch XAMPP" when Setup has finished' +echo '*****************************************************' +echo +chmod +x ${XAZ} +sudo ./${XAZ} +fi +echo + +echo Blowfish Library +if [ ! -e /usr/local/lib/libblowfish.so ]; then +cd ${DOWNLOADS}/Blowfish-Source +make +echo +fi + +echo Lodepng Library +if [ ! -e /usr/local/lib/liblodepng.so ]; then +cd ${DOWNLOADS}/Lodepng-Source +make +echo +fi + +echo SSP-API Library +if [ ! -e /usr/local/lib/libsspapi.so ]; then +cd ${DOWNLOADS}/SSP-API-Source +make +echo +fi + +echo PHP Extension +if [ ! -e ${DOWNLOADS}/PHP-EXT-Source/modules/sspphp.so ]; then +echo +cd ${DOWNLOADS}/PHP-EXT-Source +/opt/lampp/bin/phpize +./configure --enable-sspphp --with-php-config=/opt/lampp/bin/php-config +sudo make install +echo +echo '*****************************************************' +echo 'Editing /opt/lampp/etc/php.ini...' +echo 'Locate the section on Dynamic Extensions (~ line 925)' +echo 'Add the line: extension=sspphp.so' +echo 'Save the file (^O ) and close the editor (^X)' +echo '*****************************************************' +echo +sudo $EDITOR /opt/lampp/etc/php.ini +pause 'Press to continue...' +echo +fi + +echo SSP-API-Demo +cd ${DOWNLOADS} +if [ ! -d ${DESKTOP}/SSP-API-Demo ]; then +mkdir ${DESKTOP}/SSP-API-Demo +if [ ! -d ${DESKTOP}/SSP-API-Demo ]; then +echo 'Unable to create folder ${DESKTOP}/SSP-API-Demo'; exit; fi + +cp ${DOWNLOADS}/SSP-API-Source/ssphttp ${DESKTOP}/SSP-API-Demo +cp ${DOWNLOADS}/SSP-API-Source/sspfunc ${DESKTOP}/SSP-API-Demo +cp ${DOWNLOADS}/SSP-API-Demo/.sspapi.cfg ${DESKTOP}/SSP-API-Demo +cp ${DOWNLOADS}/SSP-API-Demo/ssp.server.crt ${DESKTOP}/SSP-API-Demo +cp ${DOWNLOADS}/SSP-API-Demo/ssp.server.key ${DESKTOP}/SSP-API-Demo +cp ${DOWNLOADS}/SSP-API-Demo/DebugFilter.txt ${DESKTOP}/SSP-API-Demo +cp ${DOWNLOADS}/SSP-API-Demo/rx.sh ${DESKTOP}/SSP-API-Demo +cp ${DOWNLOADS}/SSP-API-Demo/rh.sh ${DESKTOP}/SSP-API-Demo +cp ${DOWNLOADS}/SSP-API-Demo/rf.sh ${DESKTOP}/SSP-API-Demo +chmod +x ${DESKTOP}/SSP-API-Demo/rh.sh +chmod +x ${DESKTOP}/SSP-API-Demo/rf.sh +chmod +x ${DESKTOP}/SSP-API-Demo/rx.sh +fi + +if [ ! -e /opt/lampp/etc/ssl.crt/server.crt.old ]; then +sudo mv /opt/lampp/etc/ssl.crt/server.crt /opt/lampp/etc/ssl.crt/server.crt.old +sudo ln -s ${DOWNLOADS}/SSP-API-Demo/web.server.crt /opt/lampp/etc/ssl.crt/server.crt +fi + +if [ ! -e /opt/lampp/etc/ssl.key/server.key.old ]; then +sudo mv /opt/lampp/etc/ssl.key/server.key /opt/lampp/etc/ssl.key/server.key.old +sudo ln -s ${DOWNLOADS}/SSP-API-Demo/web.server.key /opt/lampp/etc/ssl.key/server.key +fi + +if [ ! -e /opt/lampp/htdocs/sqrl ]; then +sudo mkdir /opt/lampp/htdocs/sqrl +sudo ln -s ${DOWNLOADS}/SSP-API-Demo/sqrl.index.php /opt/lampp/htdocs/sqrl/index.php +fi + +if [ ! -e /opt/lampp/htdocs/auth ]; then +sudo mkdir /opt/lampp/htdocs/auth +sudo ln -s ${DOWNLOADS}/SSP-API-Demo/auth.index.php /opt/lampp/htdocs/auth/index.php +fi + +if [ ! -e /opt/lampp/htdocs/test ]; then +sudo mkdir /opt/lampp/htdocs/test +sudo ln -s ${DOWNLOADS}/SSP-API-Demo/test.index.php /opt/lampp/htdocs/test/index.php +sudo cp ${DOWNLOADS}/SSP-API-Demo/.sspapi.cfg /opt/lampp/htdocs/test +sudo cp ${DOWNLOADS}/SSP-API-Demo/DebugFilter.txt /opt/lampp/htdocs/test +sudo chmod a+w -R /opt/lampp/htdocs/test +fi + +echo + +# Customize with the server ip address +echo '****************************************************' +echo 'Running hostname.-I ...' +echo 'Make a note of your ip address' +echo '****************************************************' +echo +hostname -I +echo +pause 'Press to continue...' +echo +echo '****************************************************' +echo 'Editing /etc/hosts...' +echo 'Add these two lines using your ip address' +echo ' ssp.server' +echo ' web.server' +echo 'Save the file (^O ) and close the editor (^X)' +echo '****************************************************' +echo +sudo ${EDITOR} /etc/hosts +pause 'Press to continue...' +echo +echo '****************************************************' +echo 'Editing '${DESKTOP}'/SSP-API-Demo/.sspapi.cfg...' +echo 'For ListenIP=' +echo ' Replace with your ip address' +echo 'For PrivateAccessIp=' +echo ' Replace with your ip address' +echo 'Save the file (^O ) and close the editor (^X)' +echo '****************************************************' +echo +${EDITOR} ${DESKTOP}/SSP-API-Demo/.sspapi.cfg +pause 'Press to continue...' +echo +sudo ldconfig +echo 'Done. Continue at step 14 in install.html' +