kore

An easy to use, scalable and secure web application framework for writing web APIs in C.
Commits | Files | Refs | README | LICENSE | git clone https://git.kore.io/kore.git

README.md (3660B)



      1 About
      2 -----
      3 
      4 Kore (https://kore.io) is a web application platform for writing scalable,
      5 concurrent web based processes in C or Python.
      6 
      7 It is built with a "secure by default" approach. It is fully privilege
      8 separated while using strong security features at the operating system level
      9 such as seccomp, pledge, unveil and more.
     10 
     11 Today Kore is used in a variety of applications ranging from high assurance
     12 cryptographic devices, machine-learning stacks and even in the aerospace
     13 industry.
     14 
     15 From embedded platforms all the way to high performance servers. *Kore scales.*
     16 
     17 Key Features
     18 ------------
     19 * Supports SNI
     20 * Supports HTTP/1.1
     21 * Websocket support
     22 * Privseps by default
     23 * TLS enabled by default
     24 * Optional background tasks
     25 * Built-in parameter validation
     26 * Optional asynchronous PostgreSQL support
     27 * Optional support for page handlers in Python
     28 * Reload private keys and certificates on-the-fly
     29 * Automatic X509 certificates via ACME (with privsep)
     30 * Private keys isolated in separate process (RSA and ECDSA)
     31 * Default sane TLS ciphersuites (PFS in all major browsers)
     32 * Modules can be reloaded on-the-fly, even while serving content
     33 * Worker processes sandboxed on OpenBSD (pledge) and Linux (seccomp)
     34 * Event driven (epoll/kqueue) architecture with per CPU worker processes
     35 * Build your web application as a precompiled dynamic library or single binary
     36 
     37 And lots more.
     38 
     39 License
     40 -------
     41 * Kore is licensed under the ISC license
     42 
     43 Documentation
     44 --------------
     45 [Read the documentation](https://docs.kore.io/4.2.0/)
     46 
     47 Performance
     48 -----------
     49 Read the [benchmarks](https://blog.kore.io/posts/benchmarks) blog post.
     50 
     51 Platforms supported
     52 -------------------
     53 * Linux
     54 * OpenBSD
     55 * FreeBSD
     56 * MacOS
     57 
     58 Kore only supports x64, arm and aarch64 architectures.
     59 
     60 Building Kore
     61 -------------
     62 Clone this repository or get the latest release at [https://kore.io/releases/4.2.3](https://kore.io/releases/4.2.3).
     63 
     64 Requirements
     65 * openssl 1.1.1 or libressl 3.x
     66 (note: openssl 3.0.0 is currently *not* supported)
     67 
     68 Requirement for asynchronous curl (optional)
     69 * libcurl (7.64.0 or higher)
     70 
     71 Requirements for background tasks (optional)
     72 * pthreads
     73 
     74 Requirements for pgsql (optional)
     75 * libpq
     76 
     77 Requirements for python (optional)
     78 * Python 3.6+
     79 
     80 Normal compilation and installation:
     81 
     82 ```
     83 $ cd kore
     84 $ make
     85 # make install
     86 ```
     87 
     88 If you would like to build a specific flavor, you can enable
     89 those by setting a shell environment variable before running **_make_**.
     90 
     91 * ACME=1 (compiles in ACME support)
     92 * CURL=1 (compiles in asynchronous curl support)
     93 * TASKS=1 (compiles in task support)
     94 * PGSQL=1 (compiles in pgsql support)
     95 * DEBUG=1 (enables use of -d for debug)
     96 * NOHTTP=1 (compiles Kore without HTTP support)
     97 * NOOPT=1 (disable compiler optimizations)
     98 * JSONRPC=1 (compiles in JSONRPC support)
     99 * PYTHON=1 (compiles in the Python support)
    100 * TLS_BACKEND=none (compiles Kore without any TLS backend)
    101 
    102 Note that certain build flavors cannot be mixed together and you will just
    103 be met with compilation errors.
    104 
    105 Example applications
    106 -----------------
    107 You can find example applications under **_examples/_**.
    108 
    109 The examples contain a README file with instructions on how
    110 to build or use them.
    111 
    112 Mailing lists
    113 -------------
    114 
    115 **patches@kore.io** - Send patches here, preferably inline.
    116 
    117 **users@kore.io** - Questions regarding kore.
    118 
    119 
    120 If you want to signup to those mailing lists send an empty email to
    121 	listname+subscribe@kore.io
    122 
    123 
    124 Other mailboxes (these are **not** mailing lists):
    125 
    126 **security@kore.io** - Mail this email if you think you found a security problem.
    127 
    128 **sponsor@kore.io** - If your company would like to sponsor part of Kore development.
    129 
    130 More information can be found on https://kore.io/