Skip to content

Commit

Permalink
Add docs. Restructure.
Browse files Browse the repository at this point in the history
  • Loading branch information
chintal committed May 28, 2024
1 parent 16b02ff commit 821577c
Show file tree
Hide file tree
Showing 12 changed files with 36 additions and 22 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Generate Doxygen Documentation

on:
push:
branches:
- main
workflow_dispatch:

jobs:
generate-docs:
uses: ebs-universe/gh-workflows/.github/workflows/doxygen.yml@main
3 changes: 3 additions & 0 deletions doxygen.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"include_path": "src/"
}
6 changes: 3 additions & 3 deletions library.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ebs-cryptolib",
"version": "0.1.0",
"version": "0.2.0",
"description": "Cryptography libraries repacked for convenience from AVR Crypto Lib",
"keywords": "ebs",
"repository": {
Expand All @@ -9,12 +9,12 @@
},
"authors": {
"name": "Chintalagiri Shashank",
"email": "shahshank[email protected]",
"email": "shashank[email protected]",
"url": "https://github.com/chintal",
"maintainer": true
},
"license": "GPL-3.0-or-later",
"homepage": "https://github.com/ebs-universe",
"homepage": "https://ebs-universe.github.io/piolib-cryptolib",
"frameworks": "*",
"platforms": "*",
"dependencies": [
Expand Down
8 changes: 4 additions & 4 deletions src/cryptolib/aes/aes_dec.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@

#include <stdint.h>
#include <string.h>
#include "cryptolib/gf256mul/gf256mul.h"
#include "cryptolib/aes/aes.h"
#include "cryptolib/aes/aes_invsbox.h"
#include "cryptolib/aes/aes_dec.h"
#include "../gf256mul/gf256mul.h"
#include "aes.h"
#include "aes_invsbox.h"
#include "aes_dec.h"


// static
Expand Down
8 changes: 4 additions & 4 deletions src/cryptolib/aes/aes_enc.c
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@

#include <stdint.h>
#include <string.h>
#include "cryptolib/aes/aes.h"
#include "cryptolib/gf256mul/gf256mul.h"
#include "cryptolib/aes/aes_sbox.h"
#include "cryptolib/aes/aes_enc.h"
#include "aes.h"
#include "../gf256mul/gf256mul.h"
#include "aes_sbox.h"
#include "aes_enc.h"

static
void aes_shiftcol(void *data, uint8_t shift)
Expand Down
6 changes: 3 additions & 3 deletions src/cryptolib/aes/aes_keyschedule.c
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
*/

#include <stdint.h>
#include "cryptolib/aes/aes.h"
#include "cryptolib/aes/aes_keyschedule.h"
#include "cryptolib/aes/aes_sbox.h"
#include "aes.h"
#include "aes_keyschedule.h"
#include "aes_sbox.h"
#include <string.h>
#include <platform/romem.h>

Expand Down
2 changes: 1 addition & 1 deletion src/cryptolib/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
#ifndef CRYPTO_CONFIG_H
#define CRYPTO_CONFIG_H

#define CRYPTO_VERSION "0.1.0"
#define CRYPTO_VERSION "0.2.0"

#endif
4 changes: 2 additions & 2 deletions src/cryptolib/entropium/entropium.c
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@

#include <stdint.h>
#include <string.h>
#include "cryptolib/sha256/sha256.h"
#include "cryptolib/entropium/entropium.h"
#include "../sha256/sha256.h"
#include "entropium.h"

/**
* \brief secret entropy pool.
Expand Down
2 changes: 1 addition & 1 deletion src/cryptolib/gf256mul/gf256mul.c
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
*
*/

#include "cryptolib/gf256mul/gf256mul.h"
#include "gf256mul.h"

uint8_t gf256mul(uint8_t a, uint8_t b, uint8_t reducer) {
uint8_t r = 0, c = 8;
Expand Down
2 changes: 1 addition & 1 deletion src/cryptolib/md5/md5.c
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
*
*/

#include "cryptolib/md5/md5.h"
#include "md5.h"
#include <stdint.h>
#include <string.h>
#include <platform/romem.h>
Expand Down
4 changes: 2 additions & 2 deletions src/cryptolib/sha1/sha1.c
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@

#include <string.h> /* memcpy & co */
#include <stdint.h>
#include "cryptolib/common/debug.h"
#include "cryptolib/sha1/sha1.h"
#include "../common/debug.h"
#include "sha1.h"

#ifdef DEBUG
# undef DEBUG
Expand Down
2 changes: 1 addition & 1 deletion src/cryptolib/sha256/sha256.c
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
#include <stdint.h>
#include <string.h> /* for memcpy, memmove, memset */
#include <platform/romem.h>
#include "cryptolib/sha256/sha256.h"
#include "sha256.h"

#define LITTLE_ENDIAN

Expand Down

0 comments on commit 821577c

Please sign in to comment.