Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history 
commit 1c26ef8
Author: vnugent <[email protected]>
Date:   Wed May 29 13:34:20 2024 -0400

    missed extra argument

commit 88c9095
Author: vnugent <[email protected]>
Date:   Wed May 29 13:25:51 2024 -0400

    refactor!: return NC_SUCCESS when validating secret key

commit 718be80
Author: vnugent <[email protected]>
Date:   Mon May 27 14:52:41 2024 -0400

    fix: Properly build mbedtls & cmake fixes

commit a8a6efb
Author: vnugent <[email protected]>
Date:   Sun May 26 17:39:40 2024 -0400

    chore: Update libs, reorder files, internalize private headers

commit 72e1b7b
Author: vnugent <[email protected]>
Date:   Sun May 26 13:39:08 2024 -0400

    fix: Add c++ extern prototypes in noscrypt.h

commit aeaac8d
Author: vnugent <[email protected]>
Date:   Sun May 26 11:47:17 2024 -0400

    refactor: Dep update, openssl chacha20 added

commit 86b0254
Author: vnugent <[email protected]>
Date:   Sat May 18 12:24:17 2024 -0400

    refactor: Remove NCContext structure definition

commit d09d933
Author: vnugent <[email protected]>
Date:   Mon May 13 22:33:50 2024 -0400

    fix: update mbedtls inline issue includes

commit 7838cb4
Author: vnugent <[email protected]>
Date:   Mon May 13 22:29:16 2024 -0400

    fix: force fPIC for secp256k1 targets

commit d76f770
Merge: aa8033d a526139
Author: vnugent <[email protected]>
Date:   Sun May 12 00:37:01 2024 -0400

    Merge branch 'master' into develop

commit aa8033d
Author: vnugent <[email protected]>
Date:   Sun May 12 00:34:20 2024 -0400

    Final overview and test before tag

commit 4e3ead2
Merge: 2cee801 872c49d
Author: vnugent <[email protected]>
Date:   Mon May 6 22:08:09 2024 -0400

    Merge branch 'master' into develop

commit 2cee801
Author: vnugent <[email protected]>
Date:   Mon May 6 22:02:39 2024 -0400

    Ensure static and dynamic libs get same args

commit f533694
Author: vnugent <[email protected]>
Date:   Mon May 6 21:50:29 2024 -0400

    feat: CMake install & fetch-content test & updates

commit 940ff20
Author: vnugent <[email protected]>
Date:   Sun May 5 14:07:28 2024 -0400

    codeberg readonly push

commit b34ed05
Merge: 0a40e20 e737556
Author: vnugent <[email protected]>
Date:   Sat May 4 14:06:45 2024 -0400

    Merge branch 'master' into develop

commit 0a40e20
Author: vnugent <[email protected]>
Date:   Sat May 4 13:55:19 2024 -0400

    ci: Force disable testing for win ci builds

commit 55fae18
Author: vnugent <[email protected]>
Date:   Thu May 2 21:54:35 2024 -0400

    feat: Working and tested openssl impl & defaults

commit 6ff8bb1
Author: vnugent <[email protected]>
Date:   Thu Apr 25 17:45:42 2024 -0400

    refactor: Finish support and testing for mbedtls

commit 7cb7a93
Author: vnugent <[email protected]>
Date:   Tue Apr 23 18:19:31 2024 -0400

    refactor!: MbedTLS on Windows, switch to uint32

commit 30e8dda
Author: vnugent <[email protected]>
Date:   Tue Apr 23 14:48:05 2024 -0400

    refactor: Crypto dep redesign working on Windows

commit d09c6c1
Author: vnugent <[email protected]>
Date:   Thu Apr 18 00:28:51 2024 -0400

    refactor!: Pushing what I have to dev

commit 54e06ad
Author: vnugent <[email protected]>
Date:   Sat Apr 13 01:24:00 2024 -0400

    fix: convert constants to hex, inline macro, ParseErrorCode

commit 4215e31
Merge: d3328f4 7485aa5
Author: vnugent <[email protected]>
Date:   Wed Apr 3 18:26:30 2024 -0400

    Merge branch 'master' into develop

commit d3328f4
Author: vnugent <[email protected]>
Date:   Wed Apr 3 18:22:56 2024 -0400

    build: Included dependency and versions in client builds

commit b11bc0b
Author: vnugent <[email protected]>
Date:   Wed Apr 3 18:10:08 2024 -0400

    fix: Fix c89 compatabilty comments and struct assignment

commit 9915bd4
Merge: 8e3d6ea 5184d7d
Author: vnugent <[email protected]>
Date:   Sat Mar 30 09:57:30 2024 -0400

    Merge branch 'master' into develop

commit 8e3d6ea
Author: vnugent <[email protected]>
Date:   Sat Mar 30 09:52:55 2024 -0400

    refactor!: Some api (struct) changes and updated tests

commit e88e842
Merge: 490dfee 21f6c0a
Author: vnugent <[email protected]>
Date:   Sun Mar 3 15:02:34 2024 -0500

    Merge branch 'master' into develop

commit 490dfee
Author: vnugent <[email protected]>
Date:   Sun Mar 3 14:59:25 2024 -0500

    test: #3 tests for encryption/description and Macs

commit efa9749
Merge: 1b84e3c 120022a
Author: vnugent <[email protected]>
Date:   Sun Mar 3 14:55:48 2024 -0500

    merge master

commit 1b84e3c
Author: vnugent <[email protected]>
Date:   Sat Mar 2 22:57:36 2024 -0500

    fix: #2 constent usage of sizeof() operator on struct types

commit 9de5a21
Author: vnugent <[email protected]>
Date:   Fri Mar 1 14:30:36 2024 -0500

    perf: avoid nc_key struct copy, cast and verify instead

commit b917b76
Author: vnugent <[email protected]>
Date:   Mon Feb 12 22:06:50 2024 -0500

    fix: found the constant time memcompare function

commit 9f85fff
Author: vnugent <[email protected]>
Date:   Fri Feb 9 22:48:35 2024 -0500

    feat: added/update MAC functions to sign or verify nip44 payload

commit aa51137
Author: vnugent <[email protected]>
Date:   Wed Feb 7 01:37:53 2024 -0500

    add missing hmac-key output buffer

commit 55f47d2
Author: vnugent <[email protected]>
Date:   Sun Feb 4 21:08:13 2024 -0500

    simple bug fixes, and public api argument validation tests

commit 73c5a71
Author: vnugent <[email protected]>
Date:   Fri Feb 2 23:05:48 2024 -0500

    update api to return secpvalidate return code instead of internal return codes

commit 06c7300
Author: vnugent <[email protected]>
Date:   Fri Feb 2 19:25:17 2024 -0500

    change to lgpl license

commit 6e79fdb
Author: vnugent <[email protected]>
Date:   Wed Jan 31 21:30:49 2024 -0500

    move validation macros, and optionally disable them

commit ac1e588
Author: vnugent <[email protected]>
Date:   Tue Jan 30 12:25:05 2024 -0500

    couple more tests, renable range checks, set flags for all projects
  • Loading branch information
@VnUgE
VnUgE committed May 29, 2024
1 parent a526139 commit 51d0aff
Show file tree
Hide file tree
Showing 30 changed files with 997 additions and 555 deletions.
87 changes: 61 additions & 26 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ option(NC_DISABLE_INPUT_VALIDATION "Disables public function input validation" O
option(NC_FETCH_MBEDTLS "Fetch Mbed-TLS from it's source repository locally" OFF)
option(NC_FETCH_SECP256K1 "Fetch and locally build secp256k1 source code" ON)
option(NC_INCLUDE_MONOCYPHER "Statically link to vendored monocypher library" ON)
set(CRYPTO_LIB "" CACHE STRING "The crypto library to link to (mbedtls, openssl)")
set(CRYPTO_LIB "" CACHE STRING "The crypto library to link to (mbedtls, openssl, bcrypt)")
set(CRYPTO_LIB_DIR "" CACHE STRING "The path to the crypto library if it's not globally available")
set(SECP256K1_LIB_DIR "" CACHE STRING "An optional path to search for the secp256k1 library if not globally installed")

Expand All @@ -40,7 +40,7 @@ if(NC_FETCH_SECP256K1)
set(SECP256K1_BUILD_EXAMPLES OFF)
set(SECP256K1_BUILD_EXHAUSTIVE_TESTS OFF)
set(SECP256K1_ENABLE_MODULE_ECDH ON)
set(SECP256K1_ENABLE_MODULE_RECOVERY ON)
set(SECP256K1_ENABLE_MODULE_RECOVERY OFF)
set(SECP256K1_ENABLE_MODULE_SCHNORRSIG ON)
set(SECP256K1_ENABLE_MODULE_EXTRAKEYS ON)
set(SECP256K1_ENABLE_MODULE_ELLSWIFT OFF)
Expand All @@ -50,12 +50,21 @@ if(NC_FETCH_SECP256K1)
FetchContent_Declare(
libsecp256k1
GIT_REPOSITORY https://github.com/bitcoin-core/secp256k1
GIT_TAG 1ad5185cd42c0636104129fcc9f6a4bf9c67cc40 # release-0.4.1
GIT_TAG e3a885d42a7800c1ccebad94ad1e2b82c4df5c65 # release-0.5.0
GIT_PROGRESS TRUE
)

FetchContent_MakeAvailable(libsecp256k1)


#Must force FPIC when using secp256k1, ld linker complains otherwise
set_target_properties(
secp256k1
secp256k1_precomputed

PROPERTIES
POSITION_INDEPENDENT_CODE ON
)

else()

#search for an existing library, it's a required dependency
Expand All @@ -71,39 +80,46 @@ endif()
# MAIN PROJECT
#-----------------------------

include_directories(include) #include the 'include' directory for the project
set(CMAKE_C_STANDARD 90) #Setup the compiler options for c90 shared library
set(CMAKE_C_STANDARD_REQUIRED ON)
set(CMAKE_POSITION_INDEPENDENT_CODE ON)
set(CMAKE_C_EXTENSIONS OFF)

set(NOSCRYPT_SRCS
"src/noscrypt.c"
"src/crypto/hkdf.c"
"src/crypto/nc-crypto.c" #pulls in c impl files as needed
"src/hkdf.c"
"src/nc-crypto.c" #pulls in c impl files as needed
)

set(NOSCRYPT_HEADERS
"include/noscrypt.h"
"include/platform.h"
"include/nc-util.h"
"include/hkdf.h"
"include/nc-crypto.h"
"src/nc-util.h"
"src/hkdf.h"
"src/nc-crypto.h"
)

#static/shared library
add_library(${_NC_PROJ_NAME} SHARED ${NOSCRYPT_SRCS} ${NOSCRYPT_HEADERS})
add_library(${_NC_PROJ_NAME}_static STATIC ${NOSCRYPT_SRCS} ${NOSCRYPT_HEADERS})
target_compile_features(${_NC_PROJ_NAME} PUBLIC c_std_90) #force compiler to use c90 standard for library
set_target_properties(${_NC_PROJ_NAME} PROPERTIES POSITION_INDEPENDENT_CODE ON) #fPIC for shared library

#set specific cmake commands to target our projects only
set_target_properties(
${_NC_PROJ_NAME}
${_NC_PROJ_NAME}_static

#Setup the compiler options for c90 standard
PROPERTIES
C_STANDARD 90
C_STANDARD_REQUIRED ON
C_EXTENSIONS ON #enables c++ style comments (only required for mbedtls stuff)
)

target_compile_features(${_NC_PROJ_NAME} PRIVATE c_std_90) #force compiler to use c90 standard for library
target_compile_features(${_NC_PROJ_NAME}_static PRIVATE c_std_90) #force compiler to use c90 standard for library

target_include_directories(${_NC_PROJ_NAME} PRIVATE include)
target_include_directories(${_NC_PROJ_NAME}_static PRIVATE include)

#link libsecp256k1
if(MSVC)
target_link_libraries(${_NC_PROJ_NAME} PRIVATE secp256k1)
target_link_libraries(${_NC_PROJ_NAME}_static PRIVATE secp256k1)
else()
target_link_libraries(${_NC_PROJ_NAME} INTERFACE secp256k1)
target_link_libraries(${_NC_PROJ_NAME}_static INTERFACE secp256k1)
endif()
target_link_libraries(${_NC_PROJ_NAME} PRIVATE secp256k1)
target_link_libraries(${_NC_PROJ_NAME}_static PRIVATE secp256k1)

#include secp256k1 headers
target_include_directories(${_NC_PROJ_NAME} SYSTEM PUBLIC vendor/secp256k1/include)
Expand Down Expand Up @@ -131,6 +147,11 @@ endif()
#Include mbedtls if enabled
if(NC_FETCH_MBEDTLS)

###############
# NOTE: Must disable shared libraries to avoid linking errors when using mbedtls
###############
set(BUILD_SHARED_LIBS OFF)

set(ENABLE_PROGRAMS OFF)
set(ENABLE_TESTING OFF)
set(USE_SHARED_MBEDTLS_LIBRARY OFF)
Expand Down Expand Up @@ -333,16 +354,30 @@ endif()
target_compile_definitions(${_NC_PROJ_NAME} PRIVATE ${NC_PROJ_DEFINTIONS})
target_compile_definitions(${_NC_PROJ_NAME}_static PRIVATE ${NC_PROJ_DEFINTIONS})

#TESTS
############################
#
# TESTS
#
###########################
if(NC_BUILD_TESTS)

#add test executable and link to library
#add test executable and link to shared library for more realistic usage
add_executable(nctest tests/test.c)
target_link_libraries(nctest ${_NC_PROJ_NAME}_static)
target_link_libraries(nctest ${_NC_PROJ_NAME})
target_include_directories(nctest PRIVATE include)
target_include_directories(nctest PRIVATE src) #allow access to internal headers

#enable c11 for testing
target_compile_features(nctest PRIVATE c_std_11)

enable_testing()

add_test(
NAME nctest
COMMAND nctest
CONFIGURATIONS ${CMAKE_BUILD_TYPE}
)

endif()

###########################
Expand Down
14 changes: 14 additions & 0 deletions CMakePresets.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@
"CMAKE_BUILD_TYPE": "Debug",
"NC_BUILD_TESTS": true
}
},
{
"name": "x64-debug-openssl",
"displayName": "x64 Debug Openssl",
"inherits": "x64-debug",
"architecture": {
"value": "x64",
"strategy": "external"
},
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug",
"NC_BUILD_TESTS": true,
"CRYPTO_LIB": "openssl"
}
},
{
"name": "x64-release",
Expand Down
65 changes: 53 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
# noscrypt

# noscrypt

<h4 align="left">
<a href="https://github.com/VnUgE/noscrypt/blob/master/LICENSE">
<img src="https://img.shields.io/badge/license-LGPL2.1-green.svg" alt="LGPL2.1" />
</a>
<a href="https://github.com/VnUgE/noscrypt/tags">
<img src="https://img.shields.io/github/v/tag/vnuge/noscrypt" alt="Latest tag"/>
</a>
<a href="https://github.com/VnUgE/noscrypt/commits">
<img src="https://img.shields.io/github/last-commit/vnuge/noscrypt/master" alt="Latest commit"/>
</a>
</h4>

*A compact, C90 cross-platform, cryptography library built specifically for nostr*

## What is noscrypt?
Expand All @@ -17,8 +31,6 @@ NCVerifyMac()
... extended functions
```

There are no functions that handle key generation, because secp256k1 simply requires a 32byte random number that needs to only be validated. I assume most applications will prefer and or have better random number generators than I can assume. Use your preferred or platform CSRNG.

## Motivation
At the time of building this project I have not come across any C-only libraries that exposed functionality for nostr specific cryptography. IMO it is easy to use the secp256k1 library incorrectly. In the process of building [NVault](https://github.com/VnUgE/NVault) NIP-44 came out in December and I realized my libraries were falling short for my needs for proper and safe nostr cryptographic operations, and I needed to start over and start with a good base that has all the basic functionality built with trusted and tested libraries.

Expand Down Expand Up @@ -47,11 +59,11 @@ The following table lists the supported platforms and cryptography libraries tha
| FreeBSD | OpenSSL (3.0), Mbed-TLS | GCC Only | |


## Packages and Docs
## Getting started
GitHub is simply a mirror for my projects. Extended documentation, pre-compiled binaries and source code bundles are always available on my website, along with PGP signatures and checksums.

[Docs and Articles](https://www.vaughnnugent.com/resources/software/articles?tags=docs,_noscrypt)
[Builds and Source](https://www.vaughnnugent.com/resources/software/modules/noscrypt)
- **[Documentation](https://www.vaughnnugent.com/resources/software/articles?tags=docs,_noscrypt)**
- **[Signed builds and sourcecode ](https://www.vaughnnugent.com/resources/software/modules/noscrypt)**

### Getting the package
There are 3 ways to get the source code to build this project.
Expand All @@ -60,25 +72,54 @@ There are 3 ways to get the source code to build this project.
3. Download a github archive or release when they are available

## Building
Please see extended documentation for all custom build configurations and tips. For now, here is enough to get most developers going.
**The following build commands may be incomplete.** Please read documentation (link above) for all custom build configurations and tips.

### CMake
### Using CMake
```shell
cmake -S . -Bbuild/ -DCMAKE_BUILD_TYPE=Release
```

#### Enable built-in tets and debug mode
Enable built-in tests and debug mode
```shell
cmake -S . -Bbuild/test -DCMAKE_BUILD_TYPE=Debug -DNC_BUILD_TESTS=ON
```

#### Specify the crypto library
Specify the crypto library
```shell
cmake -S . -Bbuild/ -DCMAKE_BUILD_TYPE=Release -DCRYPTO_LIB=<openssl | mbedtls | bcrypt>
```

### Easy mode
A [Taskfile](https://taskfile.dev) file is included for easy building if you wish to build in easy mode! Use the `task --list-all` to see all available commands. The default command `task` will build the library in release mode using defaults. You may specify extra cmake build variables using the `USER_ARGS` variable on the command line.
Install library globally
```shell
cmake --install build/
```

### Using Task
A [Taskfile](https://taskfile.dev) file is included for easy building if you wish to build in easy mode! Use the `task --list` to see all available commands. The default command `task` will build the library locally in release mode using defaults.

```shell
task
```
Build in debug mode with tests enabled
```shell
task build-debug
```

Build in debug mode, with testing enabled, then runs the test executable after it's built
```shell
task test
```

Install globally. Run after running the default task or `build-debug` task
```shell
task install
```

Task accepts any extra arguments following `--` and passes them to the cmake build command.
Example:
```shell
task <command> -- -DCMAKE_X_X=x
```

## Notes
#### Builds
Expand Down
39 changes: 28 additions & 11 deletions Taskfile.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,13 @@ tasks:
desc: "Builds a local copy of the library in a debug configuration, then runs the test executable"
cmds:
- task: build-debug
- cmd: cd {{.CMAKE_BUILD_DIR}} && {{if eq OS "windows"}}debug/nctest.exe{{else}}./nctest{{end}}
- cmd: cd {{.CMAKE_BUILD_DIR}} && ctest -C Debug --verbose

install:
desc: "Uses cmake to install the library on your system"
cmds:
- cmd: echo "Installing noscrypt globally"
silent: true
- cmd: cmake --install {{.CMAKE_BUILD_DIR}} {{.CLI_ARGS}}


Expand Down Expand Up @@ -119,10 +121,16 @@ tasks:
#tar up the source
- tar -czf "{{.TARGET_SOURCE}}" {{.SOURCE_FILES}}

#################################
#
# DEV TASKS
#
#################################

dev-update-deps:
desc: "Updates vendored projects files (headers mostly) from their source repositories to the latest version"
cmds:
- defer: powershell rm -Recurse '.update/' -Force
- task: dev-update-monocypher
- task: dev-update-mbedtls-headers
- task: dev-update-openssl-headers
Expand All @@ -132,13 +140,11 @@ tasks:
MC_GIT_URL: 'https://github.com/LoupVaillant/Monocypher'
MC_GIT_BRANCH: 'master' #NOTE: Always update to the latest master branch, then verify changes manually
MC_DIR: 'vendor/monocypher'
TMP_DIR: '.task/mc'
TMP_DIR: '.update/mc'
cmds:
- cmd: powershell mkdir '{{.TMP_DIR}}' -Force
ignore_error: true

- defer: powershell rm -Recurse '{{.TMP_DIR}}' -Force

- git clone --branch {{.MC_GIT_BRANCH}} {{.MC_GIT_URL}} '{{.TMP_DIR}}'

- for: [ 'src/monocypher.h', 'src/monocypher.c' ]
Expand All @@ -149,13 +155,11 @@ tasks:
MBEDTLS_GIT_URL: 'https://github.com/Mbed-TLS/mbedtls'
MBEDTLS_GIT_BRANCH: 'development'
MBEDTLS_DIR: 'vendor/mbedtls'
TMP_DIR: '.task/mbedtls'
TMP_DIR: '.update/mbedtls'
cmds:
- cmd: powershell mkdir '{{.TMP_DIR}}' -Force
ignore_error: true

- defer: powershell rm -Recurse '{{.TMP_DIR}}' -Force

- git clone --branch {{ .MBEDTLS_GIT_BRANCH }} {{ .MBEDTLS_GIT_URL }} '{{ .TMP_DIR }}'

- for: [ 'include/mbedtls', 'include/psa' ]
Expand All @@ -166,14 +170,27 @@ tasks:
OPENSSL_GIT_URL: 'git://git.openssl.org/openssl.git'
OPENSSL_GIT_BRANCH: 'master'
OPENSSL_DIR: 'vendor/openssl'
TMP_DIR: '.task/openssl'
TMP_DIR: '.update/openssl'
cmds:
- cmd: powershell mkdir '{{.TMP_DIR}}' -Force
ignore_error: true

- defer: powershell rm -Recurse '{{.TMP_DIR}}' -Force

- git clone --branch {{ .OPENSSL_GIT_BRANCH }} {{ .OPENSSL_GIT_URL }} '{{ .TMP_DIR }}'

- for: [ 'include/openssl' ]
cmd: powershell cp -Recurse -Force '{{ .TMP_DIR }}/{{ .ITEM }}' '{{.OPENSSL_DIR}}/include/openssl/'
cmd: powershell cp -Recurse -Force '{{ .TMP_DIR }}/{{ .ITEM }}' '{{.OPENSSL_DIR}}/include/'

dev-set-secp256-headers:
vars:
SECP256_GIT_URL: 'https://github.com/bitcoin-core/secp256k1'
SECP256_GIT_BRANCH: 'v0.5.0'
SECP256_DIR: 'vendor/secp256k1'
TMP_DIR: '.update/openssl'
cmds:
- cmd: powershell mkdir '{{.TMP_DIR}}' -Force
ignore_error: true

- git clone --branch {{ .SECP256_GIT_BRANCH }} {{ .SECP256_GIT_URL }} '{{ .TMP_DIR }}'

- for: [ 'include/*' ]
cmd: powershell cp -Recurse -Force '{{ .TMP_DIR }}/{{ .ITEM }}' '{{.SECP256_DIR}}/include/secp256k1/'
Loading

0 comments on commit 51d0aff

Please sign in to comment.