From 9d303b7855dd71929ae14fd7da916589ac32193e Mon Sep 17 00:00:00 2001 From: Avinal Kumar Date: Thu, 4 Dec 2025 21:13:31 +0530 Subject: [PATCH] Improve GitHub Actions flow and increse Cmake version - Increased CMake minimum version to 3.30 - added test run in github workflow Signed-off-by: Avinal Kumar --- .github/workflows/cmake.yml | 47 ++++++++++------------ .gitignore | 1 + CMakeLists.txt | 79 +++++++++++++++++++------------------ README.md | 53 +++++++++++++++++++++---- 4 files changed, 108 insertions(+), 72 deletions(-) diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml index 9b2d686..23da715 100644 --- a/.github/workflows/cmake.yml +++ b/.github/workflows/cmake.yml @@ -1,29 +1,24 @@ -name: Build C++ Project - -on: [push] - +name: Build and Test +on: [push, pull_request] jobs: build: - name: Build on Ubuntu with GCC - runs-on: ubuntu-latest # For Gitea, ensure you have a runner with the 'ubuntu-latest' label - - # Environment variables for the C/C++ compiler - env: - CC: gcc - CXX: g++ - + runs-on: ubuntu-latest + strategy: + matrix: {compiler: [gcc, clang], build_type: [Release, Debug]} steps: - # Step 1: Check out the repository code - - name: Checkout repository - uses: actions/checkout@v4 # Updated to the latest version for best practice - # Note for Gitea: Ensure your instance can access this action or use a native 'git clone' command. - - # Step 2: Configure the project and build it - - name: Configure and Build - run: | - # Configure using CMake. The -B flag creates the 'build' directory. - # The build type is now hardcoded to 'Debug'. - cmake -B build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_VERBOSE_MAKEFILE=ON . - - # Build the project using the generated configuration. - cmake --build build --config Debug + - uses: actions/checkout@v4 + - name: Install deps + run: sudo apt-get update && sudo apt-get install -y build-essential cmake + - name: Configure + run: cmake -S . -B build -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} + - name: Build + run: cmake --build build -j + - name: Run tests + run: ctest --output-on-failure -C ${{ matrix.build_type }} -V + sanitize: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_FLAGS="-fsanitize=address,undefined -fno-omit-frame-pointer" + - run: cmake --build build -j + - run: ctest --output-on-failure -C Debug -V diff --git a/.gitignore b/.gitignore index 0536712..1773118 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,4 @@ cmake-build-debug build .vscode +.cache diff --git a/CMakeLists.txt b/CMakeLists.txt index 7ac8ea8..25e02df 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,53 +1,54 @@ -cmake_minimum_required(VERSION 3.1) +cmake_minimum_required(VERSION 3.30) project(blowfish VERSION 1.0.0 LANGUAGES CXX) +message(STATUS "CMake version: ${CMAKE_VERSION}") +message(STATUS "Project version: ${PROJECT_VERSION}") -if (NOT CMAKE_CXX_STANDARD) - set(CMAKE_CXX_STANDARD 14) -elseif (CMAKE_CXX_STANDARD LESS 11) - message(WARNING "CMAKE_CXX_STANDARD has been set to '${CMAKE_CXX_STANDARD}' which is lower than the minimum required standard (c++14).") -endif () +# ===== compiler settings ===== +set(CMAKE_EXPORT_COMPILE_COMMANDS ON) -message(STATUS "Using C++ standard c++${CMAKE_CXX_STANDARD}") +set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED ON) +message(STATUS "Using C++ standard c++${CMAKE_CXX_STANDARD}") -message (STATUS "CMake version: ${CMAKE_VERSION}") -message (STATUS "Project version: ${PROJECT_VERSION}") +set(BF_INCLUDE_DIR ${PROJECT_SOURCE_DIR}/include) -set(BLOWFISH_SRC ${PROJECT_SOURCE_DIR}/src/blowfish.cc) -set(BLOWFISH2_SRC ${PROJECT_SOURCE_DIR}/src/blowfish2.cc) -source_group(src FILES ${BLOWFISH_SRC} ${BLOWFISH2_SRC}) +# ===== blowfish library ===== +add_library(blowfish) +target_compile_features(blowfish PUBLIC cxx_std_17) -set(BLOWFISH_TEST ${PROJECT_SOURCE_DIR}/tests/Main.cpp) -set(BLOWFISH2_TEST ${PROJECT_SOURCE_DIR}/tests/Main2.cpp) -source_group(tests FILES ${BLOWFISH_TEST} ${BLOWFISH2_TEST}) - -set(BLOWFISH_INC ${PROJECT_SOURCE_DIR}/include/blowfish/blowfish.h) -set(BLOWFISH2_INC ${PROJECT_SOURCE_DIR}/include/blowfish/blowfish2.h) -source_group(include FILES ${BLOWFISH_INC} ${BLOWFISH2_INC}) - -set(BLOWFISH_DOC - README.md - LICENSE +target_sources(blowfish + PRIVATE + src/blowfish.cc + PUBLIC FILE_SET HEADERS + BASE_DIRS ${BF_INCLUDE_DIR} + FILES include/blowfish/blowfish.h ) -source_group(doc FILES ${BLOWFISH_DOC}) -set(BLOWFISH_SCRIPTS - .gitattributes - .gitignore - build.sh +target_include_directories(blowfish PUBLIC ${BF_INCLUDE_DIR}) + +# ===== blowfish2 library ===== +add_library(blowfish2) +target_compile_features(blowfish2 PUBLIC cxx_std_14) + +target_sources(blowfish2 + PRIVATE + src/blowfish2.cc + PUBLIC FILE_SET HEADERS + BASE_DIRS ${BF_INCLUDE_DIR} + FILES include/blowfish/blowfish2.h ) -source_group(scripts FILES ${BLOWFISH_SCRIPTS}) -add_library(blowfish ${BLOWFISH_SRC} ${BLOWFISH_INC} ${BLOWFISH_SCRIPTS} ${BLOWFISH_DOC}) -add_library(blowfish2 ${BLOWFISH2_SRC} ${BLOWFISH2_INC} ${BLOWFISH_SCRIPTS} ${BLOWFISH_DOC}) +target_include_directories(blowfish2 PUBLIC ${BF_INCLUDE_DIR}) -target_include_directories(blowfish PUBLIC ${PROJECT_SOURCE_DIR}/include) -target_include_directories(blowfish2 PUBLIC ${PROJECT_SOURCE_DIR}/include) - -add_executable(bf_test ${BLOWFISH_TEST} ${BLOWFISH_SRC} ${BLOWFISH_INC}) -add_executable(bf2_test ${BLOWFISH2_TEST} ${BLOWFISH2_SRC} ${BLOWFISH2_INC}) - -target_include_directories(bf_test PUBLIC ${PROJECT_SOURCE_DIR}/include) -target_include_directories(bf2_test PUBLIC ${PROJECT_SOURCE_DIR}/include) +# ===== Tests ===== +include(CTest) +if(BUILD_TESTING) + add_executable(bf_test tests/Main.cpp) + target_link_libraries(bf_test PRIVATE blowfish) + add_test(NAME bf_test COMMAND bf_test) + add_executable(bf2_test tests/Main2.cpp) + target_link_libraries(bf2_test PRIVATE blowfish2) + add_test(NAME bf2_test COMMAND bf2_test) +endif() diff --git a/README.md b/README.md index e4e38c0..441bd9b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ # Blowfish and Blowfish2 Encryption Algorithm -

buildlicense

+[![Build Status](https://github.com/avinal/blowfish/actions/workflows/cmake.yml/badge.svg)](https://github.com/avinal/blowfish/actions/workflows/cmake.yml) -Blowfish is a symmetric block cipher that can be used as a drop-in replacement for DES or IDEA. It takes a variable-length key, from 32 bits to 448 bits, making it ideal for both domestic and exportable use. Blowfish was designed in 1993 by Bruce Schneier as a fast, free alternative to existing encryption algorithms. Since then it has been analyzed considerably, and it is slowly gaining acceptance as a strong encryption algorithm. Blowfish is unpatented and license-free, and is available free for all uses. +Blowfish is a symmetric block cipher that can be used as a drop-in replacement for DES or IDEA. It +takes a variable-length key, from 32 bits to 448 bits, making it ideal for both domestic and +exportable use. Blowfish was designed in 1993 by Bruce Schneier as a fast, free alternative to +existing encryption algorithms. Since then it has been analyzed considerably, and it is slowly +gaining acceptance as a strong encryption algorithm. Blowfish is not patented and license-free, +and is available free for all uses. -Blowfish 2 was released in 2005. It has exactly the same design but has twice as many S tables and uses 64-bit integers instead of 32-bit integers. It no longer works on 64-bit blocks but on 128-bit blocks like AES. 128-bit block, 64 rounds, key up to 4224 bits. +Blowfish 2 was released in 2005. It has exactly the same design but has twice as many S tables and +uses 64-bit integers instead of 32-bit integers. It no longer works on 64-bit blocks but on 128-bit +blocks like AES. 128-bit block, 64 rounds, key up to 4224 bits. ## About this project @@ -12,8 +19,12 @@ This is a C++ implementation of the encryption algorithm. ## How to use this in your project? -1. You may fork it and use it like any other source file in your project. You only need [blowfish.hpp](include/blowfish/blowfish.hpp) and [blowfish.cpp](src/blowfish.cpp) files. Just modify the header as per your convienence. -2. If you are using CMake, the work is lot easier. You can add this as a git submodule. It isolates your project from this dependency. +1. You may fork it and use it like any other source file in your project. You only need +[blowfish.hpp](include/blowfish/blowfish.hpp) and [blowfish.cpp](src/blowfish.cpp) files. Just +modify the header as per your convenience. + +2. If you are using CMake, the work is lot easier. You can add this as a git submodule. It isolates +your project from this dependency. ```bash # In your project root type these commands @@ -21,9 +32,37 @@ This is a C++ implementation of the encryption algorithm. # considering this addition is your only change git commit -m "blowfish submodule added" git push origin main - ``` + ``` - Add this to your CMakeLists.txt as well. +Add this to your CMakeLists.txt as well. + +## Building + +This library has no dependencies on any other code. Just a C++ compiler should be enough to build +this. Although this library is supposed to be used under some other project, sometimes you may need +to build this. Here are the prerequisites: + +- [CMake](https://cmake.org/download/) +- [G++](https://gcc.gnu.org/) or [Clang](https://clang.llvm.org/) +- [Make](https://www.gnu.org/software/make/) or [Ninja Build](https://ninja-build.org/) or any other CMake compatible generator. + +Here is how I install them on Fedora: + +```shell + sudo dnf install clang cmake g++ make ninja-build +``` + +Configure CMake, enabled debug for development purposes: + +```shell + cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug +``` + +Build using configured generator: + +```shell + cmake --build build --config Debug +``` ## References