mirrors/kore
1
0
Fork 1
mirror of https://git.kore.io/kore.git synced 2024-11-16 06:56:33 +01:00
Code Issues Projects Releases Wiki Activity
1,574 Commits 5 Branches 46 Tags 4.4 MiB
C 98.6%
Makefile 1%
Shell 0.4%
06fa452c96
Go to file
Joris Vink 06fa452c96 Add a full native JSON parser to Kore. 
Mostly compliant, ignores \uXXXX in strings for now.

New API functions:

void kore_json_init(struct kore_json *json, const u_int8_t *data, size_t len);
  - Prepares JSON data for parsing.

int kore_json_parse(struct kore_json *json)
  - Parses the JSON data prepared via kore_json_init. Returns KORE_RESULT_ERROR
    if parsing failed or KORE_RESULT_OK if it succeeded.

struct kore_json_item *kore_json_get(struct kore_json *json, const char *path,
                                     int type);
  - Try to find the object matching a given search patch and type.

  eg, given a JSON structure of:
    {
      "reasons": {
        "strings": [
          "first reason",
          "second"
        ]
      }
    }

  one can obtain the second element in the reasons.strings array via:

    item = kore_json_get(json, "reasons/strings[0]", KORE_JSON_TYPE_STRING);

  Returns NULL if the item was not found or a type mismatch was hit,
  otherwise will return the item of that type.

  The kore_json_item data structure has a data member that contains the
  relevant bits depending on the type:

    KORE_JSON_TYPE_ARRAY, KORE_JSON_TYPE_OBJECT:
      the data.items member is valid.

    KORE_JSON_TYPE_STRING:
      the data.string member is valid.

    KORE_JSON_TYPE_NUMBER:
      the data.number member is valid.

    KORE_JSON_TYPE_LITERAL:
      the data.literal member is valid.

void kore_json_cleanup(struct kore_json *json);
  - Cleanup any resources

const char *kore_json_strerror(struct kore_json *json);
  - Return pointer to human readable error string.
2019-10-20 23:22:11 +02:00
conf
examples Allow multiple binds on new server directive. 2019-09-27 20:00:35 +02:00
include/kore Add a full native JSON parser to Kore. 2019-10-20 23:22:11 +02:00
kodev
misc Allow building with python3.8 2019-10-15 10:16:53 +02:00
share/man remove lingering pyko references 2019-05-13 23:23:33 +02:00
src remove FILEREF_DEBUG that sneaked in 2019-10-16 12:13:21 +02:00
.gitignore Add seccomp syscall filtering to kore. 2019-09-25 14:31:20 +02:00
LICENSE 2019 was here 9 months ago 2019-09-26 16:44:42 +02:00
Makefile Add a full native JSON parser to Kore. 2019-10-20 23:22:11 +02:00
minisign.pub
README.md fix doc link 2019-09-27 23:55:42 +02:00

README.md

About

Kore (https://kore.io) is an easy to use web application platform for writing scalable web APIs in C. Its main goals are security, scalability and allowing rapid development and deployment of such APIs.

Because of this Kore is an ideal candidate for building robust, scalable and secure web things.

Key Features

  • Supports SNI
  • Supports HTTP/1.1
  • Websocket support
  • Privseps by default
  • TLS enabled by default
  • Optional background tasks
  • Built-in parameter validation
  • Optional asynchronous PostgreSQL support
  • Optional support for page handlers in Python
  • Reload private keys and certificates on-the-fly
  • Private keys isolated in separate process (RSA and ECDSA)
  • Default sane TLS ciphersuites (PFS in all major browsers)
  • Modules can be reloaded on-the-fly, even while serving content
  • Worker processes sandboxed on OpenBSD (pledge) and Linux (seccomp)
  • Event driven (epoll/kqueue) architecture with per CPU worker processes
  • Build your web application as a precompiled dynamic library or single binary

And loads more.

License

  • Kore is licensed under the ISC license

Documentation

Read the documentation

Performance

Read the benchmarks blog post.

Platforms supported

  • Linux
  • OpenBSD
  • FreeBSD
  • MacOS

Building Kore

Clone this repository or get the latest release at https://kore.io/releases/3.2.0.

Requirements

  • openssl (1.0.2, 1.1.0 or 1.1.1) (note: libressl 3.0.0+ works as a replacement)

Requirement for asynchronous curl (optional)

  • libcurl

Requirements for background tasks (optional)

  • pthreads

Requirements for pgsql (optional)

  • libpq

Requirements for python (optional)

  • Python 3.6+

Normal compilation and installation:

$ cd kore
$ make
# make install

If you would like to build a specific flavor, you can enable those by setting a shell environment variable before running make.

  • CURL=1 (compiles in asynchronous curl support)
  • TASKS=1 (compiles in task support)
  • PGSQL=1 (compiles in pgsql support)
  • DEBUG=1 (enables use of -d for debug)
  • NOHTTP=1 (compiles Kore without HTTP support)
  • NOOPT=1 (disable compiler optimizations)
  • JSONRPC=1 (compiles in JSONRPC support)
  • PYTHON=1 (compiles in the Python support)

Note that certain build flavors cannot be mixed together and you will just be met with compilation errors.

Example applications

You can find example applications under examples/.

The examples contain a README file with instructions on how to build or use them.

Mailing lists

patches@kore.io - Send patches here, preferably inline.

users@kore.io - Questions regarding kore.

If you want to signup to those mailing lists send an empty email to listname+subscribe@kore.io

Other mailboxes (these are not mailing lists):

security@kore.io - Mail this email if you think you found a security problem.

sponsor@kore.io - If your company would like to sponsor part of Kore development.

More information can be found on https://kore.io/