Pre-Submission Checklist

Commit message has the format required by CONTRIBUTING guide
Commits are split per component (core, individual modules, libs, utils, ...)
Each component has a single commit (if not, squash them into one commit)
No commits to README files for modules (changes must be done to docbook files
in doc/ subfolder, the README file is autogenerated)

Type Of Change

Small bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds new functionality)
Breaking change (fix or feature that would change existing functionality)

Checklist:

PR should be backported to stable branches
Tested changes locally
Related to issue #XXXX (replace XXXX with an open issue number)

Description

Add auth_web3 module for blockchain-based authentication

This PR introduces a new authentication module that provides blockchain-powered
digest authentication via Oasis Sapphire smart contracts while maintaining full
compatibility with standard Kamailio auth module functions.

Key Features:

Blockchain-based digest authentication via Oasis Sapphire smart contracts
RFC2617 compliant MD5 and SHA-256 digest authentication
Full compatibility with standard auth functions (www_authenticate, proxy_authenticate)
Configurable parameters: web3_rpc_url, web3_contract_address, web3_debug_mode, web3_timeout
Comprehensive error handling for network failures and blockchain connectivity
Nonce management and replay protection identical to traditional auth

Files Added:

src/modules/auth_web3/ (complete module with 9 .c files and supporting headers)
Comprehensive documentation in doc/ subfolder
CMakeLists.txt with curl dependency handling

Testing Summary:

Build Verification: Module compiles successfully with curl dependency
Load Testing: Module loads without errors in Kamailio configuration
Authentication Scenarios:
- Valid credentials: Successful authentication with correct blockchain credentials
- Invalid credentials: Proper rejection of wrong passwords (tested with Zoiper)
- Network failures: Graceful handling of blockchain RPC connectivity issues
- Parameter validation: All module parameters properly validated
Compatibility Testing: Full compatibility with existing auth module functions
Error Handling: Comprehensive error logging and fallback behavior

Documentation Status:

Complete XML documentation in doc/ subfolder
Module parameters documented (auth_web3_params.xml)
Functions documented (auth_web3_functions.xml)
Configuration examples provided
Usage patterns and best practices included

Limitations:

Requires external blockchain RPC endpoint (Oasis Sapphire)
Network dependency for authentication (no offline fallback)
Requires curl library for HTTP requests to blockchain
Smart contract must be deployed on target blockchain network
Authentication speed depends on blockchain network response time

Build System:

Added to MOD_LIST_UTILS group for proper curl dependency handling
Includes CMakeLists.txt with find_package(CURL REQUIRED)

This module provides a drop-in replacement for traditional authentication while
leveraging blockchain technology for credential verification.

You can view, comment on, or merge this pull request online at:

https://github.com/kamailio/kamailio/pull/4328

Commit Summary

d2377ba auth_web3: initial blockchain authentication module
1b929d1 cmake: add auth_web3 to MOD_LIST_UTILS group

File Changes

(27 files)

M cmake/groups.cmake (4)
A src/modules/auth_web3/CMakeLists.txt (9)
A src/modules/auth_web3/Makefile (17)
A src/modules/auth_web3/README (1229)
A src/modules/auth_web3/api.c (324)
A src/modules/auth_web3/api.h (170)
A src/modules/auth_web3/auth_web3_mod.c (1739)
A src/modules/auth_web3/auth_web3_mod.h (54)
A src/modules/auth_web3/challenge.c (316)
A src/modules/auth_web3/challenge.h (54)
A src/modules/auth_web3/doc/Makefile (4)
A src/modules/auth_web3/doc/auth_web3.xml (174)
A src/modules/auth_web3/doc/auth_web3_faq.xml (174)
A src/modules/auth_web3/doc/auth_web3_functions.xml (405)
A src/modules/auth_web3/doc/auth_web3_params.xml (922)
A src/modules/auth_web3/nc.c (246)
A src/modules/auth_web3/nc.h (78)
A src/modules/auth_web3/nid.c (96)
A src/modules/auth_web3/nid.h (88)
A src/modules/auth_web3/nonce.c (460)
A src/modules/auth_web3/nonce.h (228)
A src/modules/auth_web3/ot_nonce.c (232)
A src/modules/auth_web3/ot_nonce.h (83)
A src/modules/auth_web3/rfc2617.c (145)
A src/modules/auth_web3/rfc2617.h (97)
A src/modules/auth_web3/rfc2617_sha256.c (150)
A src/modules/auth_web3/rfc2617_sha256.h (71)

Patch Links:

—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.