summaryrefslogtreecommitdiff
path: root/deps/base64/README.md
diff options
context:
space:
mode:
authoryangwei <[email protected]>2024-11-25 19:22:19 +0800
committeryangwei <[email protected]>2024-11-25 19:22:19 +0800
commit1199e9d83f1b2c2d47d8fb7de911674319379651 (patch)
treec6c5f49405af8a0c33ab239fac3d488d61feb1fa /deps/base64/README.md
parentcce1155ae366077cca72047887f476bae7b0856a (diff)
✨ feat(integrate utable): deps/utable
Diffstat (limited to 'deps/base64/README.md')
-rw-r--r--deps/base64/README.md84
1 files changed, 84 insertions, 0 deletions
diff --git a/deps/base64/README.md b/deps/base64/README.md
new file mode 100644
index 0000000..0555c0d
--- /dev/null
+++ b/deps/base64/README.md
@@ -0,0 +1,84 @@
+b64.c
+=====
+
+Base64 encode/decode
+
+## install
+
+```sh
+$ clib install jwerle/b64.c
+```
+
+## usage
+
+```c
+#include <b64/b64.h>
+```
+
+or
+
+```c
+#include <b64.h>
+```
+
+## example
+
+```c
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include "b64.h"
+
+int
+main (void) {
+ unsigned char *str = "brian the monkey and bradley the kinkajou are friends";
+ char *enc = b64_encode(str, strlen(str));
+
+ printf("%s\n", enc); // YnJpYW4gdGhlIG1vbmtleSBhbmQgYnJhZGxleSB0aGUga2lua2Fqb3UgYXJlIGZyaWVuZHM=
+
+ char *dec = b64_decode(enc, strlen(enc));
+
+ printf("%s\n", dec); // brian the monkey and bradley the kinkajou are friends
+ free(enc);
+ free(dec);
+ return 0;
+}
+```
+
+## api
+
+Base64 index table
+
+```c
+
+static const char b64_table[] = {
+ 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
+ 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
+ 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X',
+ 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f',
+ 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n',
+ 'o', 'p', 'q', 'r', 's', 't', 'u', 'v',
+ 'w', 'x', 'y', 'z', '0', '1', '2', '3',
+ '4', '5', '6', '7', '8', '9', '+', '/'
+};
+```
+
+Encode `unsigned char *` source with `size_t` size.
+Returns a `char *` base64 encoded string
+
+```c
+char *
+b64_encode (const unsigned char *, size_t);
+```
+
+Decode `char *` source with `size_t` size.
+Returns a `unsigned char *` base64 decoded string
+
+```c
+unsigned char *
+b64_decode (const char *, size_t);
+```
+
+## license
+
+MIT