-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add readme file for glassy library.
- Loading branch information
Showing
1 changed file
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Glassy Library | ||
|
||
An experiment of creating small library wrapper for OpenSSL functions using modern C++ features and using externallibraries providing useful types and abstractions. | ||
|
||
## Project Structure | ||
|
||
``` | ||
. | ||
├── application/ # Application code | ||
├── library/ # Core library implementation | ||
│ └── sources/ # Library source files | ||
├── tests/ # Test suite | ||
└── third_party/ # External dependencies | ||
``` | ||
|
||
## Dependencies | ||
|
||
- OpenSSL | ||
- GSL (Guidelines Support Library) | ||
- Outcome library | ||
|
||
## Features | ||
|
||
- Big number operations with OpenSSL integration | ||
- ASN.1 integer handling | ||
- Memory management helpers | ||
- Numeric conversions utilities | ||
- Not-null concepts implementation | ||
- Error handling using Outcome library | ||
|
||
|
||
|
||
## Components | ||
|
||
### Library | ||
|
||
The core library provides several key components: | ||
|
||
- `BigNum`: A wrapper around OpenSSL's BIGNUM functionality | ||
- `ASN1Integer`: ASN.1 integer implementation | ||
- `MemoryHelpers`: Memory management utilities | ||
- `NumericConversions`: Safe numeric conversion utilities | ||
- `NotNullConcepts`: Implementation of not-null pointer concepts | ||
|
||
### Tests | ||
|
||
The project includes a comprehensive test suite to ensure reliability and correctness of the implementation. |