KLone An SDK for Embedded Web Applications

KLoneAn SDK for

Embedded Web Applications

Steven DorigottiKoanLogic (http://koanlogic.com)

August 11, 2006

http://koanlogic.com

OutlineKLone

DevelopmentApplications

Wrap-Up

KLoneWhat is it?Use CasesFeaturesLibrariesWorkings

DevelopmentTutorialFine-TuningKLone-Devkit

ApplicationsIndustryOpen Source

Wrap-Up

Steven Dorigotti KoanLogic (http://koanlogic.com) KLone An SDK for Embedded Web Applications


OutlineKLone


Wrap-Up

What is it?Use CasesFeaturesLibrariesWorkings

In Brief

I lightweight web server

I C/C++ SDK

I API (GET/POST, sessions, cookies, I/O, logging, upload, ...)

I framework (compilation & building).



OutlineKLone


Wrap-Up


In Brief


I C/C++ SDK





OutlineKLone


Wrap-Up


In Brief


I C/C++ SDK





OutlineKLone


Wrap-Up


In Brief


I C/C++ SDK





OutlineKLone


Wrap-Up


Generic

web app

any C/C++ library

host FS

KLone engine

embeddedFSHTTP library

I/O library

HTTP/S client



OutlineKLone


Wrap-Up


Embedded System

web app

any C/C++ library

host FS

KLone engine


I/O library

HTTP/S client

generic WEB browseror special purpose client application

interface to appliance resources (hardware or firmware)

depends on type of appliance

client interface to appliance configuration and monitoring



OutlineKLone


Wrap-Up


Remote Procedure Calls

web app

any C/C++ library

host FS

KLone engine


I/O library

HTTP/S client

custom HTTP/S client application (e.g. TSP, DVCS, SCVP, LTAP-enabled)

handles HTTP/S request/response

possibly, crypto material needed to securely interface the backend application (may also be placed in the host FS if available)

TSP, DVCS, SCVP, LTAP API to interface a backend application



OutlineKLone


Wrap-Up


Content Management

web app

any C/C++ library

host FS

KLone engine


I/O library

HTTP/S client

client interface to document search and validation

generic WEB browserlaunched on the same host as KLone

document search and digital signature validation API

a tamper proof digitally signed set of documents (PDF, MS Word ...)a set of trust

anchors



OutlineKLone


Wrap-Up


General Features

Some standard features:

I HTTP 1.0 compliant

I TLS/SSL

I virtual hosting

...but also:

I optimised (∼ 140KB ROM, ∼ 70KB RAM)

I native compiled code

I ROMable

I Open Source (GPL/commercial).



OutlineKLone


Wrap-Up


General Features



I TLS/SSL

I virtual hosting

...but also:



I ROMable




OutlineKLone


Wrap-Up


General Features



I TLS/SSL

I virtual hosting

...but also:



I ROMable




OutlineKLone


Wrap-Up


General Features



I TLS/SSL

I virtual hosting

...but also:



I ROMable




OutlineKLone


Wrap-Up


General Features



I TLS/SSL

I virtual hosting

...but also:



I ROMable




OutlineKLone


Wrap-Up


Embedded File System

I static/dynamic pages in kloned object

I compression (zlib)

I encryption: 256-bit AES (OpenSSL).



OutlineKLone


Wrap-Up








OutlineKLone


Wrap-Up








OutlineKLone


Wrap-Up


Client-Side Sessions

I standard session features

I no storage required

I cryptographically protected cookies.

The Internet Draft can be found at the following URL:http://www.ietf.org/internet-drafts/draft-barbato-scs-00.txt


http://www.ietf.org/internet-drafts/draft-barbato-scs-00.txt


OutlineKLone


Wrap-Up










OutlineKLone


Wrap-Up










OutlineKLone


Wrap-Up










OutlineKLone


Wrap-Up


Portability

I GNU/Linux (2.2, 2.4, 2.6 - GCC 2.95.x, 3.x, both glibc anduClibc supported)

I x86, MIPS, ARM, Cris (Axis), PowerPC, SH4, m68k

I QNX 6I x86, ARM, MIPS, PowerPC, SH

I VxWorks 6.x (DCC and GCC compilers)I All supported CPUs

I FreeBSD 4.X, 5.X and 6.X

I NetBSD 2.0.X, 2.1 and 3.X

I OpenBSD 3.8

I Darwin 7 / MacOSX 10.3

I Microsoft Windows XP (MinGW framework with MSYS).



OutlineKLone


Wrap-Up


Libraries

3rd party dependencies are minimised: zlib (compression),OpenSSL (encryption).

Internally developed, BSD-licensed libraries:I LibU: utility library

I multi-platformI net, string, memory, config, hmap, ...

I MaKL: build systemI Autotools replacementI Bourne Shell & GNU MakeI toolchains



OutlineKLone


Wrap-Up


Libraries


Internally developed, BSD-licensed libraries:

I LibU: utility libraryI multi-platformI net, string, memory, config, hmap, ...




OutlineKLone


Wrap-Up


Libraries







OutlineKLone


Wrap-Up


Libraries







OutlineKLone


Wrap-Up


Workings

Runtime

Translation

<html> ...</html>

<% /* C code block */%>

$ klone -c import [-z] [-e]...

translate_script_to_c()

static embpage_t e;

static void exec_page (rq, rs, ss);static void module_init<md5> (void);

static embfile_t e;static unsigned char data[] = { 0x ... };

static void module_init<md5> (void);

translate_opaque_to_c()

Compilation

object files

static embpage_t e;




$ native_C_compiler

$ native_linker

KLone HTTP/S

server library

KLone HTTP

Helper library

kloned

kloned::server_loop()

connect

kloned::server_dispatch()

kloned::server_be_serve()

choosebackend

choosesupplier

choosepage type

sup_emb::serve_static()sup_emb::serve_dynamic()

exec_page()

https::https_serve()

client

response

sup_fs::serve()

script?

developer

$ cd site && make$ make



OutlineKLone


Wrap-Up


Workings

Runtime

Translation

<html> ...</html>




static embpage_t e;





Compilation

object files

static embpage_t e;




$ native_C_compiler

$ native_linker

KLone HTTP/S

server library

KLone HTTP

Helper library

kloned


connect



choosebackend

choosesupplier

choosepage type


exec_page()


client

response

sup_fs::serve()

script?

developer




OutlineKLone


Wrap-Up


Workings

Runtime

Translation

<html> ...</html>




static embpage_t e;





Compilation

object files

static embpage_t e;




$ native_C_compiler

$ native_linker

KLone HTTP/S

server library

KLone HTTP

Helper library

kloned


connect



choosebackend

choosesupplier

choosepage type


exec_page()


client

response

sup_fs::serve()

script?

developer




OutlineKLone


Wrap-Up


Workings

Runtime

Translation

<html> ...</html>




static embpage_t e;





Compilation

object files

static embpage_t e;




$ native_C_compiler

$ native_linker

KLone HTTP/S

server library

KLone HTTP

Helper library

kloned


connect



choosebackend

choosesupplier

choosepage type


exec_page()


client

response

sup_fs::serve()

script?

developer




OutlineKLone


Wrap-Up


Workings

Runtime

Translation

<html> ...</html>




static embpage_t e;





Compilation

object files

static embpage_t e;




$ native_C_compiler

$ native_linker

KLone HTTP/S

server library

KLone HTTP

Helper library

kloned


connect



choosebackend

choosesupplier

choosepage type


exec_page()


client

response

sup_fs::serve()

script?

developer




OutlineKLone


Wrap-Up


Workings

Runtime

Translation

<html> ...</html>




static embpage_t e;





Compilation

object files

static embpage_t e;




$ native_C_compiler

$ native_linker

KLone HTTP/S

server library

KLone HTTP

Helper library

kloned


connect



choosebackend

choosesupplier

choosepage type


exec_page()


client

response

sup_fs::serve()

script?

developer




OutlineKLone


Wrap-Up


Workings

Runtime

Translation

<html> ...</html>




static embpage_t e;





Compilation

object files

static embpage_t e;




$ native_C_compiler

$ native_linker

KLone HTTP/S

server library

KLone HTTP

Helper library

kloned


connect



choosebackend

choosesupplier

choosepage type


exec_page()


client

response

sup_fs::serve()

script?

developer




OutlineKLone


Wrap-Up

TutorialFine-TuningKLone-Devkit

Syntax

The syntax for dynamic .kl1 pages is very intuitive:

I standard HTMLI code blocks:

<% /* C/C++ code */ %>

I expression printing:<%= /* char *expression */ %>

I declarations:<%! /* C/C++ declarations */ %>

I preprocessor directives:<%@ directive [param]... %>



OutlineKLone


Wrap-Up


Syntax


I standard HTML

I code blocks:<% /* C/C++ code */ %>






OutlineKLone


Wrap-Up


Syntax



<% /* C/C++ code */ %>






OutlineKLone


Wrap-Up


Syntax



<% /* C/C++ code */ %>






OutlineKLone


Wrap-Up


Syntax



<% /* C/C++ code */ %>






OutlineKLone


Wrap-Up


Syntax



<% /* C/C++ code */ %>






OutlineKLone


Wrap-Up


Example: Hello World

<%@ include "header.kl1" %><%! #include <time.h> %><%

time_t now;int i;

now = time(NULL);io_printf(out, "today is %s <p>", ctime(&now));

for(i = 0; i < 10; ++i){

io_printf(out, "hello world! <p>");}

%><%@ include "footer.kl1" %>



OutlineKLone


Wrap-Up




time_t now;int i;


for(i = 0; i < 10; ++i){





OutlineKLone


Wrap-Up




time_t now;int i;


for(i = 0; i < 10; ++i){





OutlineKLone


Wrap-Up




time_t now;int i;


for(i = 0; i < 10; ++i){





OutlineKLone


Wrap-Up


Example: Cookies

<%! #include <string.h> %><%

vars_t *args = request_get_args(request);const char *colour = vars_get_value(args, "colour");

if (colour && strlen(colour))response_set_cookie(response, "colour", colour, \

time(NULL), NULL, NULL, 0);%><p>What is your favourite colour?<form action="colour.kl1" method="post">colour: <input type="text" name="colour"><br><input type="submit" value="submit"><br></form><p>You preference: <%= request_get_cookie(request, "colour") %>



OutlineKLone


Wrap-Up


Example: Cookies







OutlineKLone


Wrap-Up


Example: Cookies







OutlineKLone


Wrap-Up


Example: Cookies







OutlineKLone


Wrap-Up


Example: Cookies







OutlineKLone


Wrap-Up


Fine-Tuning

KLone can be configured to suit the host environment in terms of:

I CPU, memory and filesystem utilisation:I server modelI compression of content and/or sessionsI sessions: file, memory or clientI logging: file, syslog or memory

I security requirements:I uid/guidI chrootI file and/or session encryption.



OutlineKLone


Wrap-Up


Fine-Tuning

KLone can be configured to suit the host environment in terms of:I CPU, memory and filesystem utilisation:

I server modelI compression of content and/or sessionsI sessions: file, memory or clientI logging: file, syslog or memory




OutlineKLone


Wrap-Up


Fine-Tuning

KLone can be configured to suit the host environment in terms of:I CPU, memory and filesystem utilisation:

I server modelI compression of content and/or sessionsI sessions: file, memory or clientI logging: file, syslog or memory




OutlineKLone


Wrap-Up


Zero Storage / In-memory Sessions / HTTP

server_list my_http

log

{

type memory

memory.limit 200

}

my_http

{

type http

addr.type IPv4

addr.port 8080

dir_root /www

session

{

type memory

compress yes

memory.limit 8192

memory.max_count 2

}

}



OutlineKLone


Wrap-Up



server_list my_http

log

{

type memory

memory.limit 200

}

my_http

{

type http

addr.type IPv4

addr.port 8080

dir_root /www

session

{

type memory

compress yes

memory.limit 8192

memory.max_count 2

}

}



OutlineKLone


Wrap-Up



server_list my_http

log

{

type memory

memory.limit 200

}

my_http

{

type http

addr.type IPv4

addr.port 8080

dir_root /www

session

{

type memory

compress yes

memory.limit 8192

memory.max_count 2

}

}



OutlineKLone


Wrap-Up


Zero Storage / Client-side Sessions / HTTPS

server_list my_https

log

{

type memory

memory.limit 200

}

my_https

{

type https

compress yes

addr.type IPv4

addr.port 443

dir_root /www

session.type client

cert_file /etc/kloned.pem

}



OutlineKLone


Wrap-Up




log

{

type memory

memory.limit 200

}

my_https

{

type https

compress yes

addr.type IPv4

addr.port 443

dir_root /www

session.type client


}



OutlineKLone


Wrap-Up




log

{

type memory

memory.limit 200

}

my_https

{

type https

compress yes

addr.type IPv4

addr.port 443

dir_root /www

session.type client


}



OutlineKLone


Wrap-Up


KLone-Devkit

KLone-Devkit was developed with developers in mind:

I simplified learning curve

I build environmentI provides working examples:

I Fox-Demo (basic and VHDL)I PXAregs-GUII TSP-ProxyI Doc-Search.



OutlineKLone


Wrap-Up


KLone-Devkit







OutlineKLone


Wrap-Up


KLone-Devkit



I build environment

I provides working examples:I Fox-Demo (basic and VHDL)I PXAregs-GUII TSP-ProxyI Doc-Search.



OutlineKLone


Wrap-Up


KLone-Devkit







OutlineKLone


Wrap-Up


Klone-Devkit: FOX-Demo



OutlineKLone


Wrap-Up


KLone-Devkit: FOX-Demo

<html><body>

<%! #include <foxbone_userspace.h> %><%

unsigned int release, fd;fd = open("/dev/foxbone", O_RDONLY);release = ioctl(fd, IOCTL_FOXBONE_READ, \

FOXBONE_VER_REG);io_printf(out, "%x", release);close(fd);

%></body>

</html>



OutlineKLone


Wrap-Up



<html><body>




%></body>

</html>



OutlineKLone


Wrap-Up



<html><body>




%></body>

</html>



OutlineKLone


Wrap-Up



<html><body>




%></body>

</html>



OutlineKLone


Wrap-Up





OutlineKLone


Wrap-Up


KLone-Devkit: FOX-VHDL



OutlineKLone


Wrap-Up


KLone-Devkit: PXAregs-GUI



OutlineKLone


Wrap-Up


KLone-Devkit: PXAregs-GUI



OutlineKLone


Wrap-Up


KLone-Devkit: TSP-Proxy



OutlineKLone


Wrap-Up


KLone-Devkit: Doc-Search



OutlineKLone


Wrap-Up





OutlineKLone


Wrap-Up





OutlineKLone


Wrap-Up

IndustryOpen Source

Industry

KLone is currently operational in several fields of the IT industry:

I FIAT: industrial control system

I RAI: network data analyserI T-Services:

I authentication systemI validation authority.



OutlineKLone


Wrap-Up

IndustryOpen Source

Industry







OutlineKLone


Wrap-Up

IndustryOpen Source

Industry



I RAI: network data analyser

I T-Services:I authentication systemI validation authority.



OutlineKLone


Wrap-Up

IndustryOpen Source

Industry







OutlineKLone


Wrap-Up

IndustryOpen Source

Open Source: Alp-MP3



OutlineKLone


Wrap-Up

IndustryOpen Source

Open Source: Alp-MP3



OutlineKLone


Wrap-Up

Future Development

A preview:

I HTTP 1.1 compliance

I AJAX helpers

I performance & file size optimisation

I more porting.



OutlineKLone


Wrap-Up

Future Development

A preview:


I AJAX helpers


I more porting.



OutlineKLone


Wrap-Up

Future Development

A preview:


I AJAX helpers


I more porting.



OutlineKLone


Wrap-Up

Future Development

A preview:


I AJAX helpers


I more porting.



OutlineKLone


Wrap-Up

Future Development

A preview:


I AJAX helpers


I more porting.



OutlineKLone


Wrap-Up

Bookmarks

For more information:

I Info, documentation and source code: http://koanlogic.com

I Mailing lists:I [email protected]

I [email protected]

I Other information: [email protected]



mailto:[email protected]




OutlineKLone


Wrap-Up

Bookmarks




I [email protected]








OutlineKLone


Wrap-Up

Bookmarks




I [email protected]








OutlineKLone


Wrap-Up

Bookmarks




I [email protected]








OutlineKLone


Wrap-Up

Special Thanks

I Stefano Barbato

I Thomas Fossati

http://acmesystems.it http://phrozen.biz


http://acmesystems.it

http://phrozen.biz


OutlineKLone


Wrap-Up

Questions

KLone An SDK for Embedded Web Applications

Documents