Merge pull request #26 from Psiphon-Inc/next-release

v2.4.0

.github/workflows/build-windows.yml

@@ -0,0 +1,33 @@
+# On release, make a Windows release build and attach it to the release
+name: Windows Release Build
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    permissions:
+      # Required for release binary upload
+      contents: write
+
+    runs-on: windows-2019
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: egor-tensin/vs-shell@v2
+      with:
+        arch: x86
+
+    - name: Run build script
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: .\build-windows.bat
+
+    - name: Create zip
+      run: 7z a dist-windows.zip dist-windows
+
+    - uses: AButler/[email protected]
+      with:
+        files: 'dist-windows.zip'
+        repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,19 @@
+# Run test.sh
+name: Run Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - run: sudo apt update && sudo apt install -y cmake
+
+    - name: test
+      run: bash ./test.sh

base64.cpp

@@ -23,7 +23,7 @@ namespace base64 {
 
 // From https://stackoverflow.com/a/31322410/729729
 
-static const BYTE from_base64[] = {
+static const uint8_t from_base64[] = {
         255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
         255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
         255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 62, 255, 62, 255, 63,
@@ -46,13 +46,13 @@ std::string B64Encode(const std::string& buf) {
     return B64Encode((const unsigned char*)buf.c_str(), (unsigned int)buf.size());
 }
 
-std::string B64Encode(const std::vector<BYTE>& buf) {
+std::string B64Encode(const std::vector<uint8_t>& buf) {
     if (buf.empty())
         return ""; // Avoid dereferencing buf if it's empty
     return B64Encode(&buf[0], (unsigned int)buf.size());
 }
 
-std::string B64Encode(const BYTE* buf, unsigned int bufLen) {
+std::string B64Encode(const uint8_t* buf, unsigned int bufLen) {
     // Calculate how many bytes that needs to be added to get a multiple of 3
     size_t missing = 0;
     size_t ret_size = bufLen;
@@ -70,13 +70,13 @@ std::string B64Encode(const BYTE* buf, unsigned int bufLen) {
     for (unsigned int i = 0; i < ret_size / 4; ++i) {
         // Read a group of three bytes (avoid buffer overrun by replacing with 0)
         size_t index = i * 3;
-        BYTE b3[3];
+        uint8_t b3[3];
         b3[0] = (index + 0 < bufLen) ? buf[index + 0] : 0;
         b3[1] = (index + 1 < bufLen) ? buf[index + 1] : 0;
         b3[2] = (index + 2 < bufLen) ? buf[index + 2] : 0;
 
         // Transform into four base 64 characters
-        BYTE b4[4];
+        uint8_t b4[4];
         b4[0] = ((b3[0] & 0xfc) >> 2);
         b4[1] = ((b3[0] & 0x03) << 4) + ((b3[1] & 0xf0) >> 4);
         b4[2] = ((b3[1] & 0x0f) << 2) + ((b3[2] & 0xc0) >> 6);
@@ -96,27 +96,27 @@ std::string B64Encode(const BYTE* buf, unsigned int bufLen) {
     return ret;
 }
 
-std::vector<BYTE> B64Decode(const std::string& b64encoded) {
+std::vector<uint8_t> B64Decode(const std::string& b64encoded) {
     std::string encoded_string = b64encoded;
 
     // Make sure string length is a multiple of 4
     while ((encoded_string.size() % 4) != 0)
         encoded_string.push_back('=');
 
     size_t encoded_size = encoded_string.size();
-    std::vector<BYTE> ret;
+    std::vector<uint8_t> ret;
     ret.reserve(3 * encoded_size / 4);
 
     for (size_t i = 0; i < encoded_size; i += 4) {
         // Get values for each group of four base 64 characters
-        BYTE b4[4];
+        uint8_t b4[4];
         b4[0] = (encoded_string[i + 0] <= 'z') ? from_base64[(size_t)encoded_string[i + 0]] : 0xff;
         b4[1] = (encoded_string[i + 1] <= 'z') ? from_base64[(size_t)encoded_string[i + 1]] : 0xff;
         b4[2] = (encoded_string[i + 2] <= 'z') ? from_base64[(size_t)encoded_string[i + 2]] : 0xff;
         b4[3] = (encoded_string[i + 3] <= 'z') ? from_base64[(size_t)encoded_string[i + 3]] : 0xff;
 
         // Transform into a group of three bytes
-        BYTE b3[3];
+        uint8_t b3[3];
         b3[0] = ((b4[0] & 0x3f) << 2) + ((b4[1] & 0x30) >> 4);
         b3[1] = ((b4[1] & 0x0f) << 4) + ((b4[2] & 0x3c) >> 2);
         b3[2] = ((b4[2] & 0x03) << 6) + ((b4[3] & 0x3f) >> 0);

base64.hpp

@@ -25,13 +25,11 @@
 
 namespace base64 {
 
-typedef unsigned char BYTE;
-
 std::string B64Encode(const std::string& buf);
-std::string B64Encode(const std::vector<BYTE>& buf);
-std::string B64Encode(const BYTE* buf, unsigned int bufLen);
+std::string B64Encode(const std::vector<uint8_t>& buf);
+std::string B64Encode(const uint8_t* buf, unsigned int bufLen);
 
-std::vector<BYTE> B64Decode(const std::string& b64encoded);
+std::vector<uint8_t> B64Decode(const std::string& b64encoded);
 
 std::string TrimPadding(const std::string& s);
 

base64_test.cpp

@@ -1,3 +1,22 @@
+/*
+ * Copyright (c) 2022, Psiphon Inc.
+ * All rights reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
 #include "gtest/gtest.h"
 #include "base64.hpp"
 
@@ -29,54 +48,54 @@ TEST(TestBase64, Encode)
   ASSERT_EQ(b64, "Zm9vYmFy");
 
   // The vector overload
-  vector<BYTE> v;
+  vector<uint8_t> v;
   b64 = B64Encode(v);
   ASSERT_EQ(b64, "");
 
-  BYTE b[] = "f";
-  v = vector<BYTE>(b, b+1);
+  uint8_t b[] = "f";
+  v = vector<uint8_t>(b, b+1);
   b64 = B64Encode(v);
   ASSERT_EQ(b64, "Zg==");
 }
 
 TEST(TestBase64, Decode)
 {
-  vector<BYTE> v, want;
+  vector<uint8_t> v, want;
   string s;
 
   s = "";
-  want = vector<BYTE>(s.c_str(), s.c_str()+s.size());
+  want = vector<uint8_t>(s.c_str(), s.c_str()+s.size());
   v = B64Decode("");
   ASSERT_EQ(v, want);
 
   s = "fo";
-  want = vector<BYTE>(s.c_str(), s.c_str()+s.size());
+  want = vector<uint8_t>(s.c_str(), s.c_str()+s.size());
   v = B64Decode("Zm8=");
   ASSERT_EQ(v, want);
 
   s = "foo";
-  want = vector<BYTE>(s.c_str(), s.c_str()+s.size());
+  want = vector<uint8_t>(s.c_str(), s.c_str()+s.size());
   v = B64Decode("Zm9v");
   ASSERT_EQ(v, want);
 
   s = "foob";
-  want = vector<BYTE>(s.c_str(), s.c_str()+s.size());
+  want = vector<uint8_t>(s.c_str(), s.c_str()+s.size());
   v = B64Decode("Zm9vYg==");
   ASSERT_EQ(v, want);
 
   s = "fooba";
-  want = vector<BYTE>(s.c_str(), s.c_str()+s.size());
+  want = vector<uint8_t>(s.c_str(), s.c_str()+s.size());
   v = B64Decode("Zm9vYmE=");
   ASSERT_EQ(v, want);
 
   s = "foobar";
-  want = vector<BYTE>(s.c_str(), s.c_str()+s.size());
+  want = vector<uint8_t>(s.c_str(), s.c_str()+s.size());
   v = B64Decode("Zm9vYmFy");
   ASSERT_EQ(v, want);
 
   // Not padded
   s = "foob";
-  want = vector<BYTE>(s.c_str(), s.c_str()+s.size());
+  want = vector<uint8_t>(s.c_str(), s.c_str()+s.size());
   v = B64Decode("Zm9vYg");
   ASSERT_EQ(v, want);
 }

build-windows.bat

@@ -16,7 +16,8 @@ cmake -G "Visual Studio 16 2019" -A Win32 ..
 if "%ERRORLEVEL%" == "1" exit /B 1
 
 REM Build for Debug and MinSizeRel
-call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars32.bat"
+REM This doesn't need to be called in the GitHub Action build
+if "%GITHUB_ACTION%" == "" call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars32.bat"
 if "%ERRORLEVEL%" == "1" exit /B 1
 msbuild.exe -p:Configuration=Debug -p:PlatformToolset=v140 -p:PreferredToolArchitecture=x86 -p:Platform=x86 -p:PlatformTarget=x86 psicash.vcxproj
 if "%ERRORLEVEL%" == "1" exit /B 1