├── app ├── .gitkeep ├── views │ ├── .gitkeep │ └── dashboard │ │ ├── dashboard.html.tpl │ │ └── login.html.tpl ├── models │ ├── .gitkeep │ ├── nodes_membership.scm │ ├── nodes_group.scm │ └── node.scm ├── protocols │ └── .gitkeep └── controllers │ ├── .gitkeep │ └── dashboard.scm ├── conf ├── .gitkeep ├── README ├── plugins.scm └── artanis.conf ├── db ├── .gitkeep ├── sm │ └── .gitkeep └── migration │ └── .gitkeep ├── lib ├── .gitkeep └── chiba │ ├── utils.scm │ ├── linux.scm │ ├── rule-engine │ ├── utils.scm │ ├── action.scm │ └── config.scm │ ├── cli.scm │ ├── rule-engine.scm │ ├── bmc.scm │ └── redfish.scm ├── log └── .gitkeep ├── prv └── .gitkeep ├── pub ├── .gitkeep ├── css │ └── .gitkeep ├── img │ ├── .gitkeep │ ├── upload │ │ └── .gitkeep │ ├── SCL_Grammar.png │ ├── chiba-works.png │ └── chiba-arch.svg └── js │ └── .gitkeep ├── sys ├── .gitkeep ├── i18n │ ├── .gitkeep │ ├── json │ │ └── .gitkeep │ ├── po │ │ └── .gitkeep │ └── sxml │ │ └── .gitkeep └── pages │ └── .gitkeep ├── test ├── .gitkeep ├── unit │ └── .gitkeep ├── benchmark │ ├── .gitkeep │ └── README └── functional │ └── .gitkeep ├── tmp ├── .gitkeep └── cache │ ├── .gitkeep │ ├── README │ ├── migration │ └── .gitkeep │ └── route.cache ├── README ├── scripts └── run-openbmc-simulator.sh ├── ENTRY ├── docs ├── firmware-security-enhancement_jp.md ├── firmware-security-enhancement.md ├── scl.ebnf ├── install_jp.md ├── scl.md ├── install.md └── README_jp.md ├── .gitignore ├── README.md └── LICENSE /app/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /conf/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /conf/README: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /db/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /lib/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /log/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /prv/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pub/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /sys/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tmp/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | README.md -------------------------------------------------------------------------------- /app/views/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /db/sm/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pub/css/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pub/img/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pub/js/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /sys/i18n/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /sys/pages/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/unit/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tmp/cache/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tmp/cache/README: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/models/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/protocols/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /db/migration/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pub/img/upload/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /sys/i18n/json/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /sys/i18n/po/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /sys/i18n/sxml/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/benchmark/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/benchmark/README: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/controllers/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/functional/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tmp/cache/migration/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pub/img/SCL_Grammar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hardenedlinux/chiba/HEAD/pub/img/SCL_Grammar.png -------------------------------------------------------------------------------- /pub/img/chiba-works.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hardenedlinux/chiba/HEAD/pub/img/chiba-works.png -------------------------------------------------------------------------------- /tmp/cache/route.cache: -------------------------------------------------------------------------------- 1 | ;; Do not touch anything!!! 2 | ;; All things here should be automatically handled properly!!! 3 | -------------------------------------------------------------------------------- /conf/plugins.scm: -------------------------------------------------------------------------------- 1 | ;; This is a plugin configuration file, don't remove it! 2 | 3 | ;; Uncomment following lines to enable plugins. 4 | ;; Make sure you import the plugin modules here. 5 | (define-module (conf plugins) 6 | #:use-module (artanis oht)) 7 | 8 | ;; (plugin-enable! name handler) 9 | -------------------------------------------------------------------------------- /scripts/run-openbmc-simulator.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | ./qemu-system-arm -m 256 -M romulus-bmc -nographic \ 4 | -drive file=./obmc-phosphor-image-romulus.static.mtd,format=raw,if=mtd \ 5 | -net nic \ 6 | -net user,hostfwd=:127.0.0.1:2222-:22,hostfwd=:127.0.0.1:2443-:443,hostfwd=udp:127.0.0.1:2623-:623,hostname=qemu 7 | -------------------------------------------------------------------------------- /ENTRY: -------------------------------------------------------------------------------- 1 | ;; This an Artanis ENTRY file, don't remove it! 2 | 3 | (use-modules (artanis artanis) 4 | ;; Put modules you want to be imported here 5 | ;; only for this file, not controllers/views 6 | 7 | (artanis utils)) 8 | ;; Put whatever you want to be called before server initilization here 9 | 10 | (init-server #:statics '(png gif jpg jpeg ico html js json csv xml css woff woff2 ttf)) 11 | (add-to-load-path (string-append (current-toplevel) "/lib")) 12 | ;; Put whatever you want to be called before server running here 13 | -------------------------------------------------------------------------------- /docs/firmware-security-enhancement_jp.md: -------------------------------------------------------------------------------- 1 | # ファームウェアセキュリティの強化 2 | 3 | ## なぜChibaにとってセキュリティが重要なのか？ 4 | 5 | Chibaサーバーは中央管理サーバーであり、不正アクセスに対して敏感です。そのため、セキュリティ強化はChibaサーバーにとって非常に重要な機能です。 6 | 7 | さらに、各OpenBMCノードもセキュリティ強化が必要です。 8 | 9 | ## セキュリティ強化とは？ 10 | 11 | セキュリティ強化には以下が含まれます： 12 | - ファームウェア 13 | - OSのランタイム保護 14 | - ネットワークセキュリティ 15 | - ユーザー認証 16 | - データ暗号化 17 | 18 | ## 「デフォルトでのセキュリティ」は難しい 19 | 20 | [ファームウェアベースのマルウェア](https://github.com/hardenedvault/bootkit-samples) 21 | 22 | [新しいLinuxカーネルのエクスプロイト手法](https://github.com/hardenedlinux/grsecurity-101-tutorials/blob/master/threat_model/slubstick.md) 23 | -------------------------------------------------------------------------------- /app/models/nodes_membership.scm: -------------------------------------------------------------------------------- 1 | (import (artanis mvc model) 2 | (chiba utils)) 3 | 4 | (export ) 5 | 6 | ;; Model nodes_membership definition of chiba 7 | ;; Please add your license header here. 8 | ;; This file is generated automatically by GNU Artanis. 9 | (create-artanis-model 10 | nodes_membership 11 | (:deps node group) 12 | (id auto (#:primary-key)) 13 | (node_id int (#:unsigned #:not-null)) ; 2^32 nodes, enough! 14 | (group_id int (#:unsigned #:not-null)) ; 2^32 memberships, enough? 15 | (valid boolean) ; set false to remove the node from group 16 | ); DO NOT REMOVE THIS LINE!!! 17 | -------------------------------------------------------------------------------- /app/models/nodes_group.scm: -------------------------------------------------------------------------------- 1 | (import (artanis mvc model) 2 | (chiba utils)) 3 | 4 | (export ) 5 | 6 | ;; Model nodes_group definition of chiba 7 | ;; Please add your license header here. 8 | ;; This file is generated automatically by GNU Artanis. 9 | 10 | (create-artanis-model 11 | nodes_group 12 | (:deps node) 13 | (id auto (#:primary-key)) 14 | (name char-field (#:maxlen 255 #:not-null)) 15 | (created_at bigint (#:unsigned #:not-null)) 16 | (modified_at bigint (#:unsigned #:not-null)) 17 | (valid boolean) ; set false to remove group 18 | (description longtext) ; necessary? 19 | ) ; DO NOT REMOVE THIS LINE!!! 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .tarball-version 2 | #* 3 | *.info 4 | *.pdf 5 | build.log 6 | build.err* 7 | #configure 8 | obj/* 9 | *.so 10 | *.o 11 | Makefile 12 | .deps 13 | .libs 14 | autom4te.cache 15 | config.h 16 | *.doc 17 | *.x 18 | *.lo 19 | *.la 20 | aclocal.m4 21 | depcomp 22 | missing 23 | mdate-sh 24 | texinfo.tex 25 | *~ 26 | ,* 27 | aclocal.m4 28 | config.build-subdirs 29 | config.cache 30 | config.status 31 | depcomp 32 | mdate-sh 33 | missing 34 | mkinstalldirs 35 | stamp-h1 36 | *.go 37 | cscope.out 38 | cscope.files 39 | *.log 40 | *.aux 41 | *.cp 42 | *.cps 43 | *.dvi 44 | *.fn 45 | *.fns 46 | *.ky 47 | *.pg 48 | *.toc 49 | *.tp 50 | *.vr 51 | *.tps 52 | *.vrs 53 | *.pgs 54 | *.rn 55 | *.rns 56 | *.scan 57 | *.am 58 | *.d 59 | ltmain.sh 60 | libtool 61 | *#*# 62 | doc/screaming-fist.t2p/ 63 | 64 | -------------------------------------------------------------------------------- /app/controllers/dashboard.scm: -------------------------------------------------------------------------------- 1 | ;; Controller dashboard definition of chiba 2 | ;; Please add your license header here. 3 | ;; This file is generated automatically by GNU Artanis. 4 | (define-artanis-controller dashboard) ; DO NOT REMOVE THIS LINE!!! 5 | 6 | (import (app models user) 7 | (web uri) 8 | (ice-9 match) 9 | (chiba utils)) 10 | 11 | (define (gen-login-page rc) 12 | (let ((failed (params rc "failed"))) 13 | (view-render "login" (the-environment)))) 14 | 15 | (dashboard-define 16 | "login" 17 | gen-login-page) 18 | 19 | (dashboard-define 20 | "logout" 21 | (options #:session #t) 22 | (lambda (rc) 23 | (:session rc 'drop) 24 | (rc-set-cookie rc) 25 | (redirect-to rc "/"))) 26 | 27 | (dashboard-define 28 | "/" 29 | (options #:with-auth gen-login-page) 30 | (lambda (rc) 31 | (view-render "dashboard" (the-environment)))) 32 | -------------------------------------------------------------------------------- /docs/firmware-security-enhancement.md: -------------------------------------------------------------------------------- 1 | # Firmware security enhancement 2 | 3 | [日本語](docs/firmware-security-enhancement_jp.md) 4 | 5 | ## Why security is important for Chiba? 6 | 7 | Because Chiba server is a central management server, which is sensitive to unauthorized access. The security enhancement is a critical feature for Chiba server. 8 | 9 | Nevertheless, each OpenBMC node also requires security enhancement. 10 | 11 | ## What are the security enhancements? 12 | 13 | The security enhancements include: 14 | - Firmware 15 | - OS runtime protection 16 | - Network security 17 | - User authentication 18 | - Data encryption 19 | 20 | ## "Security by default" is hard 21 | 22 | [Firmware based malware](https://github.com/hardenedvault/bootkit-samples) 23 | 24 | [Neo Linux kernel exploit method](https://github.com/hardenedlinux/grsecurity-101-tutorials/blob/master/threat_model/slubstick.md) 25 | -------------------------------------------------------------------------------- /app/views/dashboard/dashboard.html.tpl: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | <@css dashboard.css %> 12 | <@js dashboard.js %> 13 | 14 | 15 | 16 |
17 |
18 |
19 |

Dashboard

20 |

Welcome to the dashboard

21 |
22 |
23 |
24 | 25 | 26 | -------------------------------------------------------------------------------- /lib/chiba/utils.scm: -------------------------------------------------------------------------------- 1 | ;; -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ;; Copyright (C) 2024 3 | ;; HardenedLinux developers 4 | ;; This is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU General Public License published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; This is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. 16 | ;; If not, see . 17 | 18 | (define-module (chiba utils) 19 | #:export (bmc-test-addr 20 | run/status)) 21 | 22 | (define bmc-test-addr (make-parameter "localhost:2443")) 23 | 24 | (define-syntax-rule (run/status status-code body ...) 25 | (catch #t 26 | (lambda () body ...) 27 | (lambda e 28 | (cond 29 | ((eq? 'artanis-err (car e)) (apply throw e)) 30 | (else (throw 'artanis-err status-code 'Unknown "~a" e)))))) 31 | -------------------------------------------------------------------------------- /app/views/dashboard/login.html.tpl: -------------------------------------------------------------------------------- 1 | 2 | 3 | <@include header.html.tpl %> 4 | 5 | 10 | 11 | 12 | 13 |
14 |
15 |
16 |
17 |
18 | Login 19 |
Username 21 | 22 |
23 |
24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/scl.ebnf: -------------------------------------------------------------------------------- 1 | trunk = ( command_expr | status_expr | operation_expr ); 2 | 3 | command_expr = server_command | global_command; 4 | status_expr = "show", (node_name | node_list), element_ref; 5 | operation_expr = ("dump", ("json" | "xml")) | "refresh", ("all" | ("group", group_name) | node_name | node_list); 6 | 7 | global_command = global_config | global_monitor | global_action | global_create; 8 | node_name = literal_string; 9 | group_name = literal_string; 10 | node_list = ( node_name | "..." ); 11 | condition = ( pred_expr | "..." ); 12 | trigger_expr = ( (condition, action_expr) | "..." ); 13 | action_expr = "action", action_cmd; 14 | element_ref = namespace, ".", ( item_name, ("..." | ("." , item_name, "..." ))); 15 | 16 | server_command = "server", node_name, ( server_sub_cmds | "..." ); 17 | server_sub_cmds = server_monitor_cmd | server_network_cmd | server_storage_cmd; 18 | 19 | monitor_cmd = "monitor", node_name, ( trigger_expr | "..." ); 20 | 21 | global_config = "config", node_list, config_expr; 22 | global_monitor = "monitor", node_list, trigger_expr; 23 | global_action = "action", node_list, action_expr; 24 | global_create = "create", node_list, create_expr; 25 | 26 | config_expr = "storage", config | "network", config | "os_image", config; 27 | 28 | command_expr = command, arguments; 29 | -------------------------------------------------------------------------------- /lib/chiba/linux.scm: -------------------------------------------------------------------------------- 1 | ;; -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ;; Copyright (C) 2024 3 | ;; HardenedLinux developers 4 | ;; This is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU General Public License published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; This is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. 16 | ;; If not, see . 17 | 18 | (define-module (chiba linux) 19 | #:use-module (chiba cli) 20 | #:use-module ((rnrs) #:select (put-bytevector)) 21 | #:export (gunzip)) 22 | 23 | (define* (mktemp #:key (pattern "/tmp/tmp-XXXXXX") (mode "w+")) 24 | (let ((port (mkstemp! (string-copy pattern) mode))) 25 | (chmod port (logand #o666 (lognot (umask)))) 26 | port)) 27 | 28 | (define (gunzip bv) 29 | (let* ((port (mktemp)) 30 | (filename (port-filename port))) 31 | (put-bytevector port bv) 32 | (close-output-port port) 33 | (let ((ret (cli-run* zcat ,filename))) 34 | (if (zero? (-status ret)) 35 | (-result ret) 36 | (error "zcat failed" ret))))) 37 | -------------------------------------------------------------------------------- /lib/chiba/rule-engine/utils.scm: -------------------------------------------------------------------------------- 1 | ;; -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ;; Copyright (C) 2024 3 | ;; HardenedLinux developers 4 | ;; This is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU General Public License published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; This is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. 16 | ;; If not, see . 17 | 18 | (define-module (chiba rule-engine utils) 19 | #:use-module (chiba app model node) 20 | #:use-module (chiba redfish) 21 | #:use-module (artanis third-party json) 22 | #:export (rule-general-call 23 | general-config 24 | make-item-getter)) 25 | 26 | (define (general-config redfish-call node-ip config-expr cmd) 27 | (let* ((config (scm->json-string config-expr)) 28 | (token (try-to-get-token-from-ip node-ip)) 29 | (api-call (make-redfish-call node-ip token))) 30 | (redfish-call api-call cmd config))) 31 | 32 | (define (rule-general-call redfish-call node-ip . args) 33 | (let* ((token (try-to-get-token-from-ip node-ip)) 34 | (api-call (make-redfish-call node-ip token))) 35 | (apply redfish-call api-call args))) 36 | 37 | (define (make-item-getter config-expr) 38 | (lambda (key) 39 | (and=> (assoc-ref config-expr key) car))) 40 | -------------------------------------------------------------------------------- /lib/chiba/cli.scm: -------------------------------------------------------------------------------- 1 | ;; -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ;; Copyright (C) 2024 3 | ;; HardenedLinux developers 4 | ;; This is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU General Public License published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; This is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. 16 | ;; If not, see . 17 | 18 | (define-module (chiba cli) 19 | #:use-module (ice-9 popen) 20 | #:use-module ((rnrs) #:select (get-string-all 21 | define-record-type)) 22 | #:export ( 23 | ? 24 | -cmd 25 | -status 26 | -result 27 | 28 | cli-run 29 | cli-run* 30 | run-with-cli 31 | run-with-cli*)) 32 | 33 | (define-record-type 34 | (fields 35 | cmd 36 | status 37 | result)) 38 | 39 | ;; run a docker command with pipe and return the output 40 | (define (cli-run cmd) 41 | (let* ((port (open-input-output-pipe cmd)) 42 | (result (get-string-all port)) 43 | (status (status:exit-val (close-pipe port)))) 44 | (make- cmd status result))) 45 | 46 | ;; open an input and output pipe, and write string into the input pipe 47 | (define (run-with-cli cmd proc) 48 | (let ((port (open-input-output-pipe cmd))) 49 | (proc port) 50 | (display #\null port) 51 | (force-output port) 52 | (let* ((result (get-string-all port)) 53 | (status (status:exit-val (close-pipe port)))) 54 | (make- cmd status result)))) 55 | 56 | (define-syntax-rule (cli-run* cmd ...) 57 | (cli-run (format #f "~{~a ~}" (list `cmd ...)))) 58 | 59 | (define-syntax-rule (run-with-cli* cmd ... proc) 60 | (run-with-cli (format #f "~{~a ~}" `(cmd ...)) proc)) 61 | -------------------------------------------------------------------------------- /app/models/node.scm: -------------------------------------------------------------------------------- 1 | (import (artanis mvc model) 2 | (chiba bmc) 3 | (chiba utils)) 4 | 5 | (export get-node-by-ip 6 | apply-token-for-node! 7 | init-new-node 8 | try-to-get-token-from-ip 9 | get-all-node-ip) 10 | 11 | ;; Model node definition of chiba 12 | ;; Please add your license header here. 13 | ;; This file is generated automatically by GNU Artanis. 14 | 15 | (create-artanis-model 16 | node 17 | (id auto (#:primary-key)) 18 | (ip char-field (#:unique #:not-null #:maxlen 45)) 19 | (token char-field (#:maxlen 512)) 20 | (vendor char-field (#:maxlen 64)) 21 | (hostname char-field (#:maxlen 255)) 22 | (model char-field (#:maxlen 64)) 23 | (firmware_version char-field (#:maxlen 50)) 24 | (last_updated bigint (#:unsigned #:not-null)) 25 | (status char-field (#:maxlen 10)) 26 | (location char-field (#:maxlen 255)) 27 | (contact_person char-field (#:maxlen 100)) 28 | (maintenance_mode boolean) 29 | (valid boolean) 30 | ) ; DO NOT REMOVE THIS LINE!!! 31 | 32 | (define* (get-node-by-ip ip #:key (check? #f)) 33 | (run/status 34 | 500 35 | (cond 36 | (($node 'get #:condition (where #:ip ip)) 37 | => identity)) 38 | (check? #f) 39 | (else (throw 'artanis-err 404 get-node-by-ip 40 | "Node ip `~a` not found!" ip)))) 41 | 42 | (define (apply-token-for-node! node) 43 | (let* ((username (assoc-ref node "username")) 44 | (password (assoc-ref node "password")) 45 | (token (get-token-from-bmc-node ip username password))) 46 | (run/status 47 | 500 48 | ($node 'update #:condition (where #:id (assoc-ref node "id")) 49 | #:token token 50 | #:last_updated (current-datetime)) 51 | token))) 52 | 53 | (define* (init-new-node #:key ip username password) 54 | (run/status 55 | 500 56 | ($node 'set #:ip ip 57 | #:username username 58 | #:password password 59 | #:token (get-token-from-bmc-node ip username password) 60 | #:last_updated (current-datetime)) 61 | (get-node-by-ip ip)) 62 | (apply-token-for-node! node)) 63 | 64 | (define (try-to-get-token-from-ip ip) 65 | (let ((node (get-node-by-ip ip #:check? #t))) 66 | (if (not node) 67 | (assoc-ref node "token") 68 | (apply-token-for-node-ip! node)))) 69 | 70 | (define (get-all-node-ip) 71 | (run/status 72 | 500 73 | (and=> ($node 'get #:columns '(ip)) 74 | (map (lambda (x) (assoc-ref x "ip")))))) 75 | -------------------------------------------------------------------------------- /docs/install_jp.md: -------------------------------------------------------------------------------- 1 | **注意：最新のGNU Artanisのバージョンをインストールすることを推奨しますが、v0.6.1はまだリリースされていないため、ソースコードから最新バージョンをインストールする必要があります。** 2 | 3 | ### Guix 4 | 5 | GNU Guixは先進的な機能的＆トランザクションパッケージマネージャーですので、ぜひ試してみてください。 6 | [GNU Guixのインストール](https://guix.gnu.org/manual/en/html_node/Installation.html)をお読みください。 7 | 8 | ```bash 9 | guix install artanis 10 | ``` 11 | 12 | ### Ubuntu 13 | Ubuntu 24.04でのみテストしています。他のLinuxディストリビューションでのテストを歓迎し、結果をお知らせください。 14 | 15 | ```bash 16 | apt -qq -y install texinfo guile-3.0 guile-3.0-dev build-essential automake git autoconf libtool libmariadb-dev-compat libmariadb-dev libnss3 libnss3-dev 17 | 18 | apt -qq -y install gettext redis redis-server libcurl4-openssl-dev 19 | ``` 20 | 21 | guile-dbi-2.1.8（tarballにはguile-dbdが含まれています）オプション 22 | 23 | ```bash 24 | wget -c https://github.com/opencog/guile-dbi/archive/guile-dbi-2.1.8.tar.gz 25 | 26 | tar xvzf guile-dbi-2.1.8.tar.gz 27 | cd guile-dbi-guile-dbi-2.1.7/guile-dbi && ./autogen.sh --no-configure && ./configure && make 28 | sudo make install 29 | cd ../.. 30 | ``` 31 | 32 | guile-dbd オプション。dbdプラグインは実際のデータベースサーバーに接続します。 33 | 34 | ```bash 35 | cd guile-dbi-guile-dbi-2.1.8/guile-dbd-mysql && ./autogen.sh --no-configure && ./configure && make 36 | sudo make install 37 | ``` 38 | 39 | このマニュアルの例ではMySQLを使用します。他のデータベース用のdbdプラグインはこちらで見つけることができます。インストール手順は同じです。 40 | 41 | guile-curl（クライアントモジュール用） 42 | 43 | ```bash 44 | git clone https://github.com/spk121/guile-curl.git 45 | cd guile-curl && git checkout v0.9 46 | ./bootstrap && ./configure --prefix=/usr && make -j 47 | make install 48 | ln -s /usr/lib/guile/3.0/extensions/libguile-curl.* /usr/lib/ 49 | ldconfig 50 | ``` 51 | 52 | 最新のGNU Artanisのインストール: 53 | 54 | ```bash 55 | git clone https://gitlab.com/hardenedlinux/artanis.git 56 | cd artanis 57 | ./autogen.sh --no-configure 58 | ./configure 59 | make -j 60 | sudo make install 61 | ``` 62 | 63 | ## テスト 64 | 65 | ### 開発者向け 66 | ChibaをQEMUベースのOpenBMCシミュレータでテストすることをお勧めします。以下の手順でシミュレータをセットアップします： 67 | 68 | OpenBMCシミュレータの実行 69 | 70 | ```bash 71 | - wget -c https://ozlabs.org/~joel/openbmc-qemu-tutorial/obmc-phosphor-image-romulus.static.mtd 72 | - sudo apt install qemu-system-arm httpie 73 | - bash scripts/run-openbmc-simulator.sh 74 | ``` 75 | 76 | Chibaの実行 77 | 78 | ```bash 79 | cd chiba 80 | art work 81 | ``` 82 | 83 | ### ベンダー向け 84 | 85 | 実際の製品環境では、Chibaは使用される特定のOpenBMCファームウェアに合わせて調整され、適切なセキュリティ強化を組み込む必要があります。このカスタマイズ要件は、商業化の機会を開きます。 86 | 87 | 現在、実際のハードウェアはありません。もしあなたがハードウェアベンダーであれば、ぜひご連絡ください：NalaGinrut@hardenedlinux.org 88 | -------------------------------------------------------------------------------- /docs/scl.md: -------------------------------------------------------------------------------- 1 | # SCL - Server Configuration Language (Draft) 2 | 3 | **SCL is under development, and the syntax and features may change in the future.** 4 | 5 | ## Design Goals 6 | 7 | SCL is a Domain-Specific Languages (DSL) for server configuration. It is designed to be simple and easy to understand. The SCL code is interpreted by the rule engine, which generates the configuration instructions for Redfish APIs to configure the server. 8 | 9 | 10 | ### What is S-Expression? 11 | 12 | S-Expression is a simple and elegant way to represent the syntax tree of a language. It is widely used in Lisp and Scheme languages. The S-Expression is a list of lists, which is easy to parse and manipulate. 13 | 14 | ### Why S-Expression? It's not so popular and different from popular languages. 15 | 16 | Good question! 17 | 18 | Short answer: It reduces the complexity in Chiba core. 19 | 20 | Longer answer: The S-Expression is simple and easy to parse, which is suitable for a DSL. The S-Expression is also easy to generate and manipulate, which is good for a rule engine. 21 | 22 | To avoid language war and focus on the core features, the SCL is designed to be S-Expression based, which is suitable for a text based AST format. We just provide SCL as Intermediary Representation (IR) for the rule engine. 23 | 24 | The language designer and compiler writers may design their own language, and compile it to SCL. Language hackers may design their own language, and compile it to SCL. 25 | 26 | Originally, we prefer write SCL directly. The SCL is a simple language, and it's easy to learn. 27 | 28 | ## How it looks like? 29 | 30 | The SCL is a simple language, and it's easy to learn. Here is an example of SCL code: 31 | 32 | ```scheme 33 | (server "ai-node-0" 34 | (monitor "ai-node-0" 35 | (condition 36 | (or (> cpu.rate 80) (> cpu.temp 90))) 37 | (action (start-new-server-with-image "ai-node-1" "ubuntu-24.04-image")))) 38 | ``` 39 | 40 | It's in natural human language so that you can easily understand it. 41 | 42 | Or more complex example: 43 | 44 | ```scheme 45 | ; Define a server with a name and basic configuration 46 | (server "ServerName" 47 | (config 48 | (network 49 | (interface "eth0" 50 | (ip "192.168.1.100") 51 | (netmask "255.255.255.0") 52 | (gateway "192.168.1.1"))) 53 | (storage 54 | (device "sda" 55 | (size "500GB") 56 | (type "SSD"))) 57 | (power 58 | (state "on")) 59 | (bmc 60 | (user "root" 61 | (password "0penBMC"))))) 62 | ``` 63 | 64 | ## Syntax 65 | 66 | The SCL sytanx was defined with [ISO-14977-EBNF](https://www.cl.cam.ac.uk/~mgk25/iso-14977.pdf), the text format can be found in [scl.ebnf](scl.ebnf). 67 | 68 | Here's the Railroad Diagram of the SCL syntax: 69 | 70 |
71 | SCL Syntax 72 |
73 | -------------------------------------------------------------------------------- /docs/install.md: -------------------------------------------------------------------------------- 1 | **NOTE: It is recommended to install the latest version of GNU Artanis, however, since the v0.6.1 hasen't been released yet, you can install the latest version from the source code.** 2 | 3 | ### Guix 4 | 5 | GNU Guix is the advanced functional & transactional package manager, we recommend you to try it. 6 | You may read the [GNU Guix installation](https://guix.gnu.org/manual/en/html_node/Installation.html) 7 | 8 | ```bash 9 | guix install artanis 10 | ``` 11 | 12 | ### Ubuntu 13 | We only tested it on Ubuntu 24.04. Welcome to test it on other Linux distributions, and please let us know the result. 14 | 15 | ```bash 16 | apt -qq -y install texinfo guile-3.0 guile-3.0-dev build-essential automake git autoconf libtool libmariadb-dev-compat libmariadb-dev libnss3 libnss3-dev 17 | 18 | apt -qq -y install gettext redis redis-server libcurl4-openssl-dev 19 | ``` 20 | 21 | #### guile-dbi-2.1.8 (The tarball included guile-dbd) *[Optional]* 22 | ```bash 23 | wget -c https://github.com/opencog/guile-dbi/archive/guile-dbi-2.1.8.tar.gz 24 | 25 | tar xvzf guile-dbi-2.1.8.tar.gz 26 | cd guile-dbi-guile-dbi-2.1.7/guile-dbi && ./autogen.sh --no-configure && ./configure && make 27 | sudo make install 28 | cd ../.. 29 | ``` 30 | 31 | #### guile-dbd *[Optional]*. The dbd plugins connect to an actual database server. 32 | ```bash 33 | cd guile-dbi-guile-dbi-2.1.8/guile-dbd-mysql && ./autogen.sh --no-configure && ./configure && make 34 | sudo make install 35 | ``` 36 | MySQL is used for the examples in this manual. You may find dbd plugins for other databases 37 | [[ https://github.com/opencog/guile-dbi][here]]. The installation process is identical. 38 | 39 | #### guile-curl for the client module. 40 | ```bash 41 | git clone https://github.com/spk121/guile-curl.git 42 | cd guile-curl && git checkout v0.9 43 | ./bootstrap && ./configure --prefix=/usr && make -j 44 | make install 45 | ln -s /usr/lib/guile/3.0/extensions/libguile-curl.* /usr/lib/ 46 | ldconfig 47 | ``` 48 | **NOTE:** You may need to make necessary soft links according to above script. 49 | 50 | #### guile-redis: 51 | ```bash 52 | git clone https://github.com/aconchillo/guile-redis.git 53 | cd guile-redis 54 | git checkout -b 2.2.0 55 | autoreconf -vif 56 | ./configure --prefix=/usr 57 | make 58 | make install 59 | ``` 60 | 61 | #### Install the latest GNU Artanis:* 62 | 63 | ```bash 64 | git clone https://gitlab.com/hardenedlinux/artanis.git 65 | cd artanis 66 | ./autogen.sh --no-configure 67 | ./configure 68 | make -j 69 | sudo make install 70 | ``` 71 | 72 | ## Test 73 | 74 | ### For developers 75 | 76 | It is recommended to test Chiba on a QEMU-based OpenBMC simulator. The following steps show how to set up the simulator: 77 | 78 | #### Run OpenBMC simulator 79 | 80 | ```bash 81 | - wget -c https://ozlabs.org/~joel/openbmc-qemu-tutorial/obmc-phosphor-image-romulus.static.mtd 82 | - sudo apt install qemu-system-arm httpie 83 | - bash scripts/run-openbmc-simulator.sh 84 | ``` 85 | 86 | #### Run Chiba 87 | 88 | ```bash 89 | cd chiba 90 | art work 91 | ``` 92 | 93 | ### For vendors 94 | 95 | In real-world product environments, Chiba must be tailored to align with the specific OpenBMC firmware in use, incorporating appropriate security enhancements. This customization requirement opens up opportunities for commercialization. 96 | 97 | For now, we don't have real hardware to test. If you are a hardware vendor, please contact us: NalaGinrut@hardenedlinux.org. 98 | -------------------------------------------------------------------------------- /lib/chiba/rule-engine/action.scm: -------------------------------------------------------------------------------- 1 | ;; -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ;; Copyright (C) 2024 3 | ;; HardenedLinux developers 4 | ;; This is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU General Public License published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; This is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. 16 | ;; If not, see . 17 | 18 | (define-module (chiba rule-engine action) 19 | #:use-module (chiba rule-engine utils) 20 | #:use-module (chiba app model node) 21 | #:use-module (chiba redfish) 22 | #:use-module (ice-9 match) 23 | #:use-module (artanis third-party json) 24 | #:export (chiba:node-action)) 25 | 26 | (define (setup-guest-node node-ip config) 27 | (define get (make-item-getter config-expr)) 28 | (let ((ip (get 'guest-ip)) 29 | (mask (get 'guest-mask)) 30 | (gateway (get 'guest-gateway)) 31 | (dns-servers (or (get 'guest-dns-servers) 32 | '())) 33 | (system-id (or (get 'system-id) "1"))) 34 | (general-config redfish:system-config! 35 | node-ip 36 | `(("DHCPv4" 37 | ("DHCPEnabled" . #t)) 38 | ("IPv4Addresses" 39 | (("Address" . ,ip) 40 | ("SubnetMask" . ,mask) 41 | ("Gateway" . ,gateway))) 42 | ("StaticNameServers" . ,dns-servers)) 43 | system-id))) 44 | 45 | ;; Install OS from PXE 46 | ;; NOTE: 47 | ;; 1. The Redfish API doesn't support the OS installation directly. 48 | ;; 2. The OS installation is done by the PXE server. 49 | ;; 3. The PXE server should be configured outside of Chiba. 50 | ;; The related OS images, scripts, and preseed files should be provided. 51 | ;; 4. Chiba only config the guest node, then force to reboot and let PXE 52 | ;; manage the OS installation. 53 | ;; 5. After the OS installation is done, Chiba should check the status and 54 | ;; call the reboot action again. 55 | (define (install-os-from-pxe node-ip config-expr) 56 | (define get (make-item-getter config-expr)) 57 | (let ((os-image (get 'os-image)) 58 | (preseed-url (get 'preseed-url)) 59 | (post-install (get 'post-install)) 60 | (system-id (or (get 'system-id) "1"))) 61 | (setup-guest-node ip config-expr) 62 | (general-action redfish:set-boot-first ip system-id "Pxe") 63 | (general-action redfish:force-pxe-boot ip) 64 | ;; TODO: Check if the installation is done, then call reboot again 65 | ;; (general-action redfish:force-reboot ip system-id) 66 | )) 67 | 68 | (define (chiba:node-action node-ip action-expr cmd) 69 | (match action-expr 70 | (('reboot system-id) 71 | (general-action redfish:force-reboot node-ip system-id)) 72 | (('install-os config-expr ...) 73 | (match boot-mode 74 | ("PXE" (install-os-from-pxe node-ip config-expr)) 75 | (else (throw 'artanis-err 400 chiba:node-action 76 | "The boot mode `~a' hasn't been implemented yet!" 77 | boot-mode)))) 78 | (else 79 | (throw 'artanis-err 400 chiba:node-action 80 | "Unknown node `~a'" node)))) 81 | -------------------------------------------------------------------------------- /lib/chiba/rule-engine.scm: -------------------------------------------------------------------------------- 1 | ;; -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ;; Copyright (C) 2024 3 | ;; HardenedLinux developers 4 | ;; This is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU General Public License published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; This is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. 16 | ;; If not, see . 17 | 18 | (define-module (chiba rule-engine) 19 | #:use-module (chiba rule-engine config) 20 | #:use-module (artanis db) 21 | #:use-module (ice-9 match) 22 | #:export (rule-engine-run)) 23 | 24 | (define (node-config node-name config-expr rc) 25 | (let ((node (db-get-node node-name))) 26 | (if node 27 | (db-update-node node-name config-expr) 28 | (throw 'artanis-err 400 node-config 29 | "Node `~a` not found!" node-name)))) 30 | 31 | (define (chiba:node-monitor node-ip monitor-expr rc) 32 | (throw 'artanis-err 501 chiba:node-monitor "Not implemented yet!")) 33 | 34 | (define (chiba:node-action node-ip action-expr rc) 35 | (throw 'artanis-err 501 chiba:node-action "Not implemented yet!")) 36 | 37 | (define (chiba:node-create node-ip create-expr rc) 38 | (throw 'artanis-err 501 chiba:node-create "Not implemented yet!")) 39 | 40 | (define *node-command-exprs* 41 | `((config . ,chiba:node-config) 42 | (monitor . ,chiba:node-monitor) 43 | (action . ,chiba:node-action) 44 | (create . ,chiba:node-create))) 45 | 46 | (define (node-handle-get cmd) 47 | (or (assq-ref *node-command-exprs* cmd) 48 | (throw 'artanis-err 400 node-handler-get 49 | "Unknown command: `~a`!" cmd))) 50 | 51 | (define (global-command-exec expr rc) 52 | (define (broadcast node-list config-expr) 53 | (for-each (lambda (node) 54 | (let ((handler (node-handler-get 'config))) 55 | (handler node config-expr rc))) 56 | node-list)) 57 | (match expr 58 | ((cmd node-name config-expr) 59 | ;; TODO: config single node 60 | (let ((handler (node-handler-get cmd))) 61 | (handler node-name config-expr rc))) 62 | ((cmd ('group group-name) config-expr) 63 | (let ((node-list (db-get-group group-name))) 64 | (broadcast node-list config-expr))) 65 | ((cmd (node-list ...) config-expr) 66 | (broadcast node-list config-expr)) 67 | (else 68 | (throw 'artanis-err 400 global-command-exec 69 | "Unknown expression: `~a`!" expr)))) 70 | 71 | (define *global-command-exprs* 72 | `((global_config . ,global-config) 73 | (global_monitor . ,global-monitor) 74 | (global_action . ,global-action) 75 | (global_create . ,global-create))) 76 | 77 | (define *status-exprs* 78 | `((show . ,show-status))) 79 | 80 | (define *operation-exprs* 81 | `((dump . ,dump-operate) 82 | (refresh . ,refresh-operate))) 83 | 84 | (define (hendle-get table expr) 85 | (and (pair? expr) 86 | (assq-ref table (car expr)))) 87 | 88 | (define (is-command-expr? expr) 89 | (assq-ref *command-exprs* expr)) 90 | 91 | (define (is-status-expr? expr) 92 | (assq-ref *status-exprs* expr)) 93 | 94 | (define (is-operation-expr? expr) 95 | (assq-ref *operation-exprs* expr)) 96 | 97 | (define (rule-engine-run sexp rc) 98 | (cond 99 | ((is-command-expr? sexp) 100 | => (lambda (handler) 101 | (handler sexp rc))) 102 | ((is-status-expr? sexp) 103 | => (lambda (handler) 104 | (handler sexp rc))) 105 | ((is-operation-expr? sexp) 106 | => (lambda (handler) 107 | (handler sexp rc))) 108 | (else 109 | (throw 'artanis-err rule-engine-run "Unknown expression: `~a`!" sexp)))) 110 | -------------------------------------------------------------------------------- /lib/chiba/bmc.scm: -------------------------------------------------------------------------------- 1 | ;; -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ;; Copyright (C) 2024-2025 3 | ;; HardenedLinux developers 4 | ;; This is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU General Public License published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; This is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. 16 | ;; If not, see . 17 | 18 | (define-module (chiba bmc) 19 | #:use-module (chiba utils) 20 | #:use-module (chiba linux) 21 | #:use-module (artanis client) 22 | #:use-module (web response) 23 | #:use-module (json) 24 | #:use-module ((rnrs) #:select (utf8->string 25 | bytevector?)) 26 | #:export (get-token-from-bmc-node 27 | bmc-get-test-token 28 | bmc/api-get 29 | bmc/api-post 30 | bmc/api-patch)) 31 | 32 | (define (http-body-cooker res body) 33 | (let ((headers (response-headers res))) 34 | (cond 35 | ((eq? (assoc-ref headers 'content-encode) 'gzip) (gunzip body)) 36 | ((string? body) body) 37 | ((bytevector? body) (utf8->string body)) 38 | (else (throw 'artanis-error http-body-cooker 39 | "Unknown content-encoding `~a'" headers body))))) 40 | 41 | (define (get-token-from-bmc-node addr username password) 42 | (call-with-values 43 | (lambda () 44 | (artanis:http-post 45 | (format #f "https://~a/login" addr) 46 | #:headers '((content-type application/json)) 47 | #:body (scm->json-string 48 | `((username . ,username) (password . ,password))))) 49 | (lambda (_ body) 50 | (assoc-ref (json-string->scm body) "token")))) 51 | 52 | (define (bmc-get-test-token) 53 | (get-token-from-bmc-node (bmc-test-addr) 'root '0penBmc)) 54 | 55 | (define (bmc/api-get addr api token) 56 | (let ((url (format #f "https://~a/~a" addr api))) 57 | (call-with-values 58 | (lambda () 59 | (artanis:http-get 60 | url 61 | #:headers `((x-auth-token ,token)) #:bytevector? #t)) 62 | (lambda (res body) 63 | (cond 64 | ((= (response-code res) 200) (http-body-cooker res body)) 65 | ((= (response-code res) 404) (throw 'artanis-error bmc/api-get 66 | "Not found `~a'" url)) 67 | ((= (response-code res) 401) (throw 'artanis-error bmc/api-get 68 | "Unauthorized `~a'" url)) 69 | (else (throw 'artanis-error 70 | "Unexpected response code `~a' from `~a'" 71 | (list res body)))))))) 72 | 73 | (define (bmc/api-post addr api token body) 74 | (let ((url (format #f "https://~a/~a" addr api))) 75 | (call-with-values 76 | (lambda () 77 | (artanis:http-post 78 | (pk 'post-url url) 79 | #:headers `((x-auth-token ,token) 80 | (content-type application/json)) 81 | #:body (pk 'post-body body))) 82 | (lambda (res body) 83 | (cond 84 | ((= (response-code res) 200) (http-body-cooker res body)) 85 | ((= (response-code res) 404) (throw 'artanis-error bmc/api-post 86 | "Not found `~a'" url)) 87 | ((= (response-code res) 401) (throw 'artanis-error bmc/api-post 88 | "Unauthorized `~a'" url)) 89 | (else (throw 'artanis-error 90 | "Unexpected response code `~a' from `~a'" 91 | (list res body)))))))) 92 | 93 | (define (bmc/api-patch addr api token body) 94 | (let ((url (format #f "https://~a/~a" addr api))) 95 | (call-with-values 96 | (lambda () 97 | (artanis:http-patch 98 | url 99 | #:headers `((x-auth-token ,token) 100 | (content-type application/json)) 101 | #:body body)) 102 | (lambda (res body) 103 | (cond 104 | ((= (response-code res) 200) (http-body-cooker res body)) 105 | ((= (response-code res) 404) (throw 'artanis-error bmc/api-patch 106 | "Not found `~a'" url)) 107 | ((= (response-code res) 401) (throw 'artanis-error bmc/api-patch 108 | "Unauthorized `~a'" url)) 109 | (else (throw 'artanis-error bmc/api-patch 110 | "Unexpected response code `~a' from `~a'" 111 | (list res body)))))))) 112 | -------------------------------------------------------------------------------- /lib/chiba/rule-engine/config.scm: -------------------------------------------------------------------------------- 1 | ;; -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ;; Copyright (C) 2024 3 | ;; HardenedLinux developers 4 | ;; This is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU General Public License published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; This is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. 16 | ;; If not, see . 17 | 18 | (define-module (chiba rule-engine config) 19 | #:use-module (chiba rule-engine utils) 20 | #:use-module (chiba app model node) 21 | #:use-module (chiba redfish) 22 | #:use-module (ice-9 match) 23 | #:use-module (artanis third-party json) 24 | #:export (chiba:node-config)) 25 | 26 | (define (system-config node-ip node-ip config-expr cmd) 27 | (general-config redfish:systems-config! node-ip system-config-expr cmd)) 28 | 29 | (define (system-update node-ip system-id system-config-expr cmd) 30 | (general-config redfish:systems-update! node-ip system-config-expr cmd)) 31 | 32 | (define (system-delete node-ip system-id system-config-expr cmd) 33 | (general-config redfish:systems-delete! node-ip system-config-expr cmd)) 34 | 35 | (define (storage-config/volumes node-ip system-id storage-id storage-config-expr rc) 36 | (let ((cmd (format #f "~a/Storage/~a/Volumes" system-id storage-id))) 37 | (system-config node-ip system-id storage-config-expr cmd))) 38 | 39 | (define (storage-update/volumes node-ip system-id storage-id volume-id storage-config-expr rc) 40 | (let ((cmd (format #f "~a/Storage/~a/Volumes/~a" system-id storage-id volume-id))) 41 | (system-update node-ip system-id storage-config-expr cmd))) 42 | 43 | (define (storage-config/drive node-ip system-id storage-id storage-config-expr rc) 44 | (let ((cmd (format #f "~a/Storage/~a/Drives" system-id storage-id))) 45 | (system-config node-ip system-id storage-config-expr cmd))) 46 | 47 | (define (storage-update/drive node-ip system-id storage-id drive-id storage-config-expr rc) 48 | (let ((cmd (format #f "~a/Storage/~a/Drives/~a" system-id storage-id drive-id))) 49 | (system-update node-ip system-id storage-config-expr cmd))) 50 | 51 | (define (storage-delete/volumes node-ip system-id storage-id storage-config-expr rc) 52 | (let ((cmd (format #f "~a/Storage/~a/Volumes" system-id storage-id))) 53 | (system-delete node-ip system-id storage-config-expr cmd))) 54 | 55 | (define (storage-delete/drive node-ip system-id storage-id storage-config-expr rc) 56 | (let ((cmd (format #f "~a/Storage/~a/Drives" system-id storage-id))) 57 | (system-delete node-ip system-id storage-config-expr cmd))) 58 | 59 | (define (storage-action/volumes node-ip system-id storage-id volume-id act storage-config-expr rc) 60 | (let ((cmd (format #f "~a/Storage/~a/Volumes/~a/Actions/~a" system-id storage-id volume-id act))) 61 | (system-config node-ip system-id storage-config-expr cmd))) 62 | 63 | (define (network-config node-ip system-id eth network-config-expr rc) 64 | (let ((cmd (format #f "~a/EthernetInterfaces/~a" system-id eth))) 65 | (system-config node-ip system-id network-config-expr cmd))) 66 | 67 | (define (chiba:node-config node-ip config-expr rc) 68 | (match config-expr 69 | (('storage-create ('mode mode) ('system-id system-id) ('storage-id storage-id) storage-config-expr ...) 70 | (case mode 71 | ((volumes) 72 | (storage-config/volumes node-ip system-id storage-id storage-config-expr rc)) 73 | ((drive) 74 | (storage-config/drive node-ip system-id storage-id storage-config-expr rc)) 75 | (else 76 | (throw 'artanis-err 400 chiba:node-config "Unknown storage mode: ~a" mode)))) 77 | (('storage-update ('mode mode) ('system-id system-id) ('storage-id storage-id) 78 | ('volume-id volume-id) storage-config-expr ...) 79 | (storage-update/volumes node-ip system-id storage-id volume-id storage-config-expr rc)) 80 | (('storage-update ('mode mode) ('system-id system-id) ('storage-id storage-id) 81 | ('drive-id drive-id) storage-config-expr ...) 82 | (storage-update/drive node-ip system-id storage-id drive-id storage-config-expr rc)) 83 | (('storage-delete ('mode mode) ('system-id system-id) ('storage-id storage-id) storage-config-expr ...) 84 | (case mode 85 | ((volumes) 86 | (storage-delete/volumes node-ip system-id storage-id storage-config-expr rc)) 87 | ((drive) 88 | (storage-delete/drive node-ip system-id storage-id storage-config-expr rc)) 89 | (else 90 | (throw 'artanis-err 400 chiba:node-config "Unknown storage mode: ~a" mode)))) 91 | (('storage-action ('mode mode) ('system-id system-id) ('storage-id storage-id) ('volume-id volume-id) 92 | ('act act) storage-config-expr ...) 93 | (storage-action/volumes node-ip system-id storage-id volume-id act storage-config-expr rc)) 94 | (('network system-id eth network-config-expr ...) 95 | (network-config node-ip system-id eth network-config-expr rc)) 96 | (('boot-order system-id mode) 97 | (rule-general-call redfish:set-boot-first node-ip system-id mode)) 98 | (else 99 | (throw 'artanis-err 400 chiba:node-config 100 | "Unknown config type: ~a" config-expr)))) 101 | -------------------------------------------------------------------------------- /docs/README_jp.md: -------------------------------------------------------------------------------- 1 | # Chibaプロジェクト - 次世代クラウドコンピューティングのフレームワーク 2 | 3 | ## 概要 4 | 5 | 次世代データセンター、または一般的に言う[コンテナ型データセンター](https://www.techtarget.com/searchdatacenter/tip/An-overview-of-containerized-data-centers-and-their-benefits)について聞いたことがあるかもしれません。ここで言う「コンテナ」とは、Dockerコンテナではなく、港で見るような実際の輸送用コンテナ、トレーラーに積載されるタイプのものを指します。 6 | 7 |
8 | コンテナ型データセンター 9 |
10 | 11 |
12 | データセンターの進化 13 |
14 | 15 | ### 仕組みは？ 16 | 17 |
18 | Chibaの仕組み 19 |
20 | 21 | コンテナ型データセンターは、モジュール型のデータセンターであり、カスタマイズ可能で、持ち運びが容易で、任意の場所に輸送可能です。サーバー、ストレージ、ネットワーク機器、冷却システムなど、データセンターに必要なすべてのコンポーネントを含む自己完結型のユニットです。コンテナ型データセンターは通常、輸送用コンテナに収容されており、輸送や展開が簡単です。 22 | 23 | Chibaプロジェクトは、OpenBMCを活用してインフラストラクチャの自動化を提供するフレームワークです。Kubernetesや仮想化のような従来のクラウドコンピューティング要件と後方互換性を保ちながら設計されています。Chibaプロジェクトは、異なる組織の特定のニーズに合わせて簡単にカスタマイズできるように柔軟で拡張可能なフレームワークです。 24 | 25 | 通常、Chibaはコンテナ型データセンター内のサーバーのOpenBMCファームウェアと通信する管理サーバー上で実行されます。Chibaは、SCL（サーバー構成言語）スクリプトを解釈して、コンテナ型データセンター内のサーバーを管理します。SCLスクリプトは、サーバーの構成を定義し、監視し、監視結果に基づいてアクションを実行するために使用されます。SCLスクリプトはChibaサーバーによって実行され、最終的にRedfish APIに変換されて、コンテナ型データセンター内のすべてのサーバーのOpenBMCファームウェアに送信されます。 26 | 27 | ### なぜ「Chiba」という名前なのか 28 | 29 | Chiba（千葉）は、港やコンテナ、ドッカーがある日本の都市です。[『ニューロマンサー』](https://en.wikipedia.org/wiki/Neuromancer)では、**ナイトシティ**とも呼ばれています。これは、上層世界を監視し制御するハッカーたちのアンダーワールドです。もし**Cyberpunk 2077**の**ナイトシティ**が好きなら、その場所がどこにあるか今わかりましたね。 30 | 31 | Chibaプロジェクトの核心的な概念は、マザーボード上の上層世界を監視し制御するファームウェアである[OpenBMC](https://en.wikipedia.org/wiki/OpenBMC)を活用することです。あるいは、「ニューロマンサー」で「マトリックス」と呼ばれる仮想現実データ空間と言えるかもしれません。 32 | 33 | ## Chibaを作った理由 34 | 35 | Chibaプロジェクトは、楽しみと利益のために作られました。 36 | 37 | 今日、私たちは非常に複雑なサプライチェーンに直面しています。その複雑さに対処するためにいくつかの最先端モデルがあります： 38 | - **メインフレームのようなオールインワンソリューション**: x86サーバーの新しいサプライチェーンを構築するためのメインフレーム手法を使用します。例：[Oxide](https://oxide.computer/)。 39 | - **GPU指向のコンピューティングノード**: ODMとしての役割を果たしながら、単一ノードのパフォーマンスを最大化し、コストパフォーマンスを最適化します。例：[Tinycorp - Tinybox](https://tinygrad.org/#tinybox)。 40 | - **ビルディングブロックアプローチ**: OEMサプライチェーンの重要なコンポーネントをビルディングブロックに抽象化し、業界ユーザーのニーズに応じて自由に組み合わせます。例：[HardenedVault](https://hardenedvault.net/)。 41 | 42 | ### ブログ記事 43 | 44 | 英語 45 | 46 | - [People who are really serious about AI should have their own datacenter](https://hardenedlinux.medium.com/people-who-are-really-serious-about-ai-should-have-their-own-datacenter-888cc10a0e4a) 47 | - [Cloud Computing’s Hidden Hero: The Untold Story of OpenBMC](https://hardenedlinux.medium.com/cloud-computings-hidden-hero-the-untold-story-of-openbmc-1d15fd29f514) 48 | 49 | ### OpenBMCを制御するプロジェクトがすでにあるのに、なぜ新しいものを作るのか？ 50 | 51 | 確かに、OpenBMCやRedfish APIを制御するプロジェクトはすでにあります。 52 | 53 | しかし、Chibaプロジェクトは単一ノードのOpenBMCのためのものではなく、多くの、あるいは大量のOpenBMCノードのためのものです。これは次世代のクラウドコンピューティングインフラストラクチャのためのものです。 54 | 55 | ### Chibaの背後にいるのは誰？ 56 | 57 | Chibaプロジェクトは、[Open Source Firmware Conference](https://osfc.io)によって認められた[HardenedLinux](https://hardenedlinux.org)によって開発されています。OSFCは、サプライチェーンのオープンエコシステムのコミュニティを構築することを目指している組織です。 58 | 59 |
60 | HardenedLinux 61 |
62 | 63 | ### Chibaを使用すべき人は？ 64 | 65 | - クラウドサービスプロバイダー: Chibaは次世代のクラウドコンピューティングインフラの構築に利用できます。 66 | - 企業: Chibaはプライベートクラウドインフラの構築に利用できます。 67 | - ハードウェアベンダー: OpenBMC標準にはハードウェアベンダー固有の部分が含まれており、Chibaでカスタマイズする必要があります。 68 | - セキュリティベンダー: Chibaはハードウェア製品のファームウェアセキュリティ強化に利用できます。 69 | 70 | 現在、テストするための実際のハードウェア（OpenBMC搭載のラック）はありません。上記のいずれかの役割でChibaに興味がある場合は、NalaGinrut@hardenedlinux.orgまでご連絡ください。 71 | 72 | **もし東京にいるなら、ぜひコーヒーでも飲みましょう ;-)。** 73 | 74 | 技術的なオタクにとって、Chibaは次世代クラウドコンピューティングのためのOpenBMCとセキュリティ強化を学ぶための良い場所です。 75 | 76 | ## 特徴 77 | 78 | ### インフラストラクチャの自動化 - 次世代データセンターの鍵 79 | 80 | 従来のクラウドコンピューティングは、ハードウェアリソースを抽象化するソフトウェアレイヤーである仮想化に基づいています。来るAI時代には、ハードウェアリソースにはGPU、TPU、FPGAなどの専用ハードウェアアクセラレータが含まれる可能性があります。仮想化ではこれらのリソースを管理するのは十分ではありません。自動スケーリング、自動修復、自動アップグレードなどは次世代クラウドコンピューティングの鍵となる機能です。これらすべての機能は、ハードウェアのコアファームウェアであるOpenBMCに基づいています。 81 | 82 | Chibaプロジェクトは、OpenBMCを活用してインフラストラクチャの自動化を提供するフレームワークです。Kubernetesや仮想化のような従来のクラウドコンピューティング要件との互換性を維持しています。 83 | 84 | ### セキュリティ強化 - マジノ線を防ぐ 85 | 86 | あなたには優れたセキュリティソフトウェア（ファイアウォール、IDS、IPSなど）や、Linuxカーネルの強化（SELinux、AppArmorなど）、または[Grsecurity](https://grsecurity.net/)のような高度なLinuxカーネルの保護策、[HardenedVaultのVED](https://hardenedvault.net/blog/2021-09-06-ved/)、[日立のAKO](https://link.springer.com/content/pdf/10.1007/s10207-020-00514-7.pdf)などがあるかもしれません。しかし、もし攻撃者がOpenBMCのようなファームウェアのroot権限を持っていたらどうでしょう？ 87 | 88 | すべてが終わりです。すべてのサイバーセキュリティの努力は愚かな[マジノ線](https://en.wikipedia.org/wiki/Maginot_Line)になります。 89 | 90 |
91 | ファームウェア攻撃 92 |
93 | 94 | 唯一の現実的な解決策は、最も基本的なレベルであるファームウェアでセキュリティを強化することです。Chibaプロジェクトは、セキュリティが強化されたOpenBMCファームウェアを要求します。標準のAPIが使用されていますが、実際のOpenBMCファームウェアは通常、ハードウェアベンダーによってカスタマイズされています。このカスタマイズは、異なるベンダー間でのリソース定義や制御メカニズムの違いのために必要です。 95 | 96 | したがって、実際の製品環境では、Chibaは使用される特定のOpenBMCファームウェアに合わせて調整され、適切なセキュリティ強化を組み込む必要があります。このカスタマイズ要件は、商業化の機会を開きます。 97 | 98 | ## 設計 99 | 100 | Chibaは、Lispの方言であるGuile Schemeで開発されています。Scheme言語は、そのシンプルさとエレガンスで理解と保守が容易です。また、インフラストラクチャの自動化用のドメイン固有言語（DSL）を開発するための良い選択でもあります。 101 | 102 | ### SCL - サーバー構成言語 103 | 104 | 詳細については、[SCLマニュアル](docs/scl.md)を参照してください。 105 | 106 | ### ファームウェアセキュリティの強化 107 | 108 | 詳細については、[ファームウェアセキュリティ強化マニュアル](docs/firmware-security-enhancement.md)を参照してください。 109 | 110 | ### アーキテクチャ 111 | 112 |
113 | Chibaの設計 114 |
115 | 116 | ## インストール 117 | 118 | [こちら](install_jp.md) 119 | 120 | **再び、もし東京にいるなら、ぜひコーヒーでも飲みましょう。** 121 | 122 | ## ライセンスと著者 123 | 124 | ChibaプロジェクトはGPLv3ライセンスの下でライセンスされています。 125 | 126 | Chibaプロジェクトは[HardenedLinux community](https://hardenedlinux.org)コミュニティによって維持されています。 127 | -------------------------------------------------------------------------------- /lib/chiba/redfish.scm: -------------------------------------------------------------------------------- 1 | ;; -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ;; Copyright (C) 2024 3 | ;; HardenedLinux developers 4 | ;; This is free software: you can redistribute it and/or modify 5 | ;; it under the terms of the GNU General Public License published by 6 | ;; the Free Software Foundation, either version 3 of the License, or 7 | ;; (at your option) any later version. 8 | 9 | ;; This is distributed in the hope that it will be useful, 10 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ;; GNU General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. 16 | ;; If not, see . 17 | 18 | (define-module (chiba redfish) 19 | #:use-module (chiba utils) 20 | #:use-module (chiba bmc) 21 | #:use-module (json) 22 | #:export (redfish:boot-config 23 | redfish:set-boot-first 24 | redfish:force-reboot 25 | redfish:systems 26 | redfish:systems-config! 27 | redfish:systems-update! 28 | redfish:systems-remove! 29 | redfish:chassis 30 | redfish:managers 31 | redfish:sessions 32 | redfish:system-power-off/soft 33 | redfish:system-power-off/hard 34 | redfish:system-power-on 35 | redfish:system-power-reboot 36 | redfish:bmc-reboot 37 | redfish:bmc-factory-reset 38 | redfish:log-entry 39 | redfish:log-delete 40 | make-redfish-call 41 | make-redfish-call/test)) 42 | 43 | (define (redfish/v1 api) 44 | (format #f "redfish/v1/~a" api)) 45 | 46 | (define (gen-redfish-api method api api-call . args) 47 | (json-string->scm (apply (api-call method 48 | (pk 'api (redfish/v1 api))) 49 | args))) 50 | 51 | (define (redfish:boot-config api-call id data) 52 | (gen-redfish-api 'patch (format #f "Systems/~a" id) api-call data)) 53 | 54 | (define* (redfish:set-boot-first api-call id item #:key (override "Once")) 55 | (redfish:boot-config 56 | api-call id 57 | (scm->json-string 58 | `(("Boot" . (("BootSourceOverrideTarget" . ,item) 59 | ("BootSourceOverrideEnabled" . ,override))))))) 60 | 61 | (define (redfish:force-reboot api-call id) 62 | (gen-redfish-api 63 | 'post (format #f "Systems/~a/Actions/ComputerSystem.Reset" id) 64 | api-call 65 | (scm->json-string '(("ResetType" . "ForceRestart"))))) 66 | 67 | (define (redfish:systems api-call) 68 | (gen-redfish-api 'get "Systems" api-call)) 69 | 70 | (define (redfish:systems-config! api-call id data) 71 | (gen-redfish-api 'post (format #f "Systems/~a" id) api-call data)) 72 | 73 | (define (redfish:systems-udpate! api-call id data) 74 | (gen-redfish-api 'patch (format #f "Systems/~a" id) api-call data)) 75 | 76 | (define (redfish:systems-remove! api-call id) 77 | (gen-redfish-api 'delete (format #f "Systems/~a" id) api-call)) 78 | 79 | (define* (redfish:chassis api-call id resource #:key (query "")) 80 | (gen-redfish-api 'get 81 | (format #f "Chassis/~a/~a~a" id resource query) 82 | api-call)) 83 | 84 | (define (redfish:managers api-call) 85 | (gen-redfish-api 'get "Managers" api-call)) 86 | 87 | (define (redfish:sessions api-call) 88 | (gen-redfish-api 'get "SessionService/Sessions" api-call)) 89 | 90 | (define (redfish:actions api-call type action data) 91 | (gen-redfish-api 92 | 'post 93 | (format #f "Systems/~a/Actions/~a" type action) 94 | api-call 95 | (scm->json-string data))) 96 | 97 | (define (redfish:system-power-off/soft api-call) 98 | (redfish:actions 99 | api-call 100 | "system" 101 | "ComputerSystem.Reset" 102 | '(("ResetType" . "GracefulShutdown")))) 103 | 104 | (define (redfish:system-power-off/hard api-call) 105 | (redfish:actions 106 | api-call 107 | "system" 108 | "ComputerSystem.Reset" 109 | '(("ResetType" . "ForceOff")))) 110 | 111 | (define (redfish:system-power-on api-call) 112 | (redfish:actions 113 | api-call 114 | "system" 115 | "ComputerSystem.Reset" 116 | '(("ResetType" . "On")))) 117 | 118 | (define (redfish:system-power-reboot api-call) 119 | (redfish:actions 120 | api-call 121 | "system" 122 | "ComputerSystem.Reset" 123 | '(("ResetType" . "GracefulRestart")))) 124 | 125 | (define (redfish:bmc-reboot api-call) 126 | (redfish:actions 127 | api-call 128 | "bmc" 129 | "Manager.Reset" 130 | '(("ResetType" . "GracefulRestart")))) 131 | 132 | (define (redfish:bmc-factory-reset api-call) 133 | (redfish:actions 134 | api-call 135 | "bmc" 136 | "Manager.ResetToDefaults" 137 | '(("ResetToDefaultsType" . "ResetAll")))) 138 | 139 | (define (redfish:log-entry api-call) 140 | (gen-redfish-api 141 | 'get 142 | "Systems/system/Actions/LogServices/EventLog/Entries" 143 | api-call)) 144 | 145 | (define (redfish:log-delete api-call) 146 | (gen-redfish-api 147 | 'post 148 | "Systems/system/LogServices/EventLog/Actions/LogService.Reset" 149 | api-call)) 150 | 151 | (define (redfish:firmware-apply-time/immediately api-call) 152 | (gen-redfish-api 153 | 'patch 154 | "UpdateService" 155 | '(("HttpPushUriOptions" 156 | ("HttpPushUriApplyTime" ("ApplyTime" . "Immediate")))))) 157 | 158 | (define (redfish:firmware-apply-time/on-reset api-call) 159 | (gen-redfish-api 160 | 'patch 161 | "UpdateService" 162 | '(("HttpPushUriOptions" 163 | ("HttpPushUriApplyTime" ("ApplyTime" . "OnReset")))))) 164 | 165 | (define (redfish:firmware-update api-call) 166 | (gen-redfish-api 167 | 'post 168 | "UpdateService/Actions/UpdateService.SimpleUpdate" 169 | api-call)) 170 | 171 | (define (make-redfish-call addr token) 172 | (lambda (method api) 173 | (lambda args 174 | (case method 175 | ((get) (bmc/api-get addr api token)) 176 | ((post) (apply bmc/api-post addr api token args)) 177 | ((patch) (apply bmc/api-patch addr api token args)) 178 | (else (throw 'artanis-error "Unknown method `~a'" method)))))) 179 | 180 | (define (make-redfish-call/test token) 181 | (make-redfish-call (bmc-test-addr) token)) 182 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Chiba project - the framework for next generation of cloud computing 2 | 3 | [日本語](docs/README_jp.md) 4 | 5 | ## Intro 6 | 7 | You might hear about next-gen data centers, or as they're more commonly known, [containerized data centers](https://www.techtarget.com/searchdatacenter/tip/An-overview-of-containerized-data-centers-and-their-benefits). The container mentioned here doesn't refer to a Docker container, but rather the actual shipping container you'd see at a port, typically carried on a truck trailer. 8 | 9 |
10 | containerized data center 11 |
12 | 13 |
14 | data center evolution 15 |
16 | 17 | ### How it works? 18 | 19 |
20 | How Chiba works 21 |
22 | 23 | The containerized data center is a modular data center that is tailorable, portable and can be transported to any location. It's a self-contained unit that includes all the necessary components for a data center, such as servers, storage, networking equipment, and cooling systems. The containerized data center is typically housed in a shipping container, which makes it easy to transport and deploy. 24 | 25 | Chiba project is a framework that leverages OpenBMC to provide infrastructure automation. It maintains backward compatibility with traditional cloud computing requirements like Kubernetes and virtualization. The Chiba project is designed to be a flexible and extensible framework that can be easily customized to meet the specific needs of different organizations. 26 | 27 | Typically, Chiba runs on a management server that communicates with the OpenBMC firmware on the servers in the containerized data center. Chiba will interpreter the SCL (Server Configuration Language) scripts to manage the servers in the containerized data center. The SCL scripts can be used to define the configuration of the servers, monitor the servers, and take action based on the monitoring results. The SCL scripts will be executed by the Chiba server and finally transformed to Redfish API sent to the OpenBMC firmware of all servers in the containerized data center. 28 | 29 | ### Why name Chiba 30 | 31 | Chiba is a Japan city with port, containers, and dockers. In [Neuromancer](https://en.wikipedia.org/wiki/Neuromancer), it's also named **night city**. the underworld of the hackers that monitors and controls the upper world. So if you like the **night city** in 2077, now you know where it is. 32 | 33 | The core concept of Chiba project is to take advantage of [OpenBMC](https://en.wikipedia.org/wiki/OpenBMC), the firmware that monitors and controls the upper world upon the motherboard, or you may say, the virtual reality dataspace that was named **the matrix** in Neuromancer. 34 | 35 | ## Why make Chiba? 36 | 37 | Chiba project was created for fun and for profit. 38 | 39 | Nowadays, we're actually facing an extreamly complex supply chain. There are several neo cutting-edge models to cope with the complexity: 40 | - **Mainframe-Like all in one solution**: It is using the mainframe methodology to build new supply chain for x86 servers. E.g, [Oxide](https://oxide.computer/). 41 | - **GPU-oriented computing node**: To maximize the performance of a single node while playing the role of an ODM, ensuring the best cost-performance ratio. E.g, [Tinycorp - Tinybox](https://tinygrad.org/#tinybox). 42 | - **Building block approach**: Abstract the critical components in the OEM supply chain into building blocks that can be freely combined based on the needs of industry users. E.g, [HardenedVault](https://hardenedvault.net/). 43 | 44 | ### Blog posts 45 | 46 | - [People who are really serious about AI should have their own datacenter](https://hardenedlinux.medium.com/people-who-are-really-serious-about-ai-should-have-their-own-datacenter-888cc10a0e4a) 47 | - [Cloud Computing’s Hidden Hero: The Untold Story of OpenBMC](https://hardenedlinux.medium.com/cloud-computings-hidden-hero-the-untold-story-of-openbmc-1d15fd29f514) 48 | 49 | ### There're projects for controling OpenBMC, why bother to create another one? 50 | 51 | Yes, there're projects for OpenBMC and Redfish API. 52 | 53 | However, Chiba project is not for single node OpenBMC, it's for many or even massive OpenBMC nodes. It's for the next generation of cloud computing infrastructure. 54 | 55 | ### Who's behind Chiba? 56 | 57 | Chiba project has been developing by [HardenedLinux](https://hardenedlinux.org), which was entitled by [Open Source Firmware Conference](https://osfc.io). OSFC is the organization devoted to building a community around Open Ecosystem of supplychain. 58 | 59 |
60 | HardenedLinux 61 |
62 | 63 | ### Who should use Chiba? 64 | 65 | - **Cloud service providers**: Chiba can be used to build the next generation of cloud computing infrastructure. 66 | - **Enterprises**: Chiba can be used to build the private cloud infrastructure. 67 | - **Hardware vendors**: OpenBMC standard contains hardware vendor specific parts, which need to be customized in Chiba. 68 | - **Security vendors**: Chiba can be used to provide the firmware security enhancement for the hardware products. 69 | 70 | For now, we don't have real hardware (rack with OpenBMC) to test. If you are any of the above roles and interested in Chiba, please contact us: NalaGinrut@hardenedlinux.org. 71 | 72 | **And if you are happen in Tokyo, let's have a coffee ;-).** 73 | 74 | For technical geeks, Chiba is a good place to learn the OpenBMC and security enhancement for next generation of cloud computing. 75 | 76 | ## What's special? 77 | 78 | ### Infrastructure automation - the key point of the next-gen data centers 79 | 80 | The traditional cloud computing is based on the virtualization, which is a software layer that abstracts the hardware resources. In the coming AI era, the hardware resources may include dedicated hardware accelerators, such as GPU, TPU, FPGA, etc. The virtualization is not enough to manage these resources. The auto scaling, auto healing, auto upgrading, etc, are the key features of the next generation of cloud computing. All these features are based on the core firmware of the hardware, which is the OpenBMC. 81 | 82 | The Chiba project is a framework that leverages OpenBMC to provide infrastructure automation. It maintains backward compatibility with traditional cloud computing requirements like Kubernetes and virtualization. 83 | 84 | ### Security enhancement - prevent the Maginot Line 85 | 86 | You may have good security software, such as firewall, IDS, IPS, etc. Linux kernel enhancement, such as SELinux, AppArmor. Or even advanced Linux kernel vaccine like [Grsecurity](https://grsecurity.net/), [VED from HardenedVault](https://hardenedvault.net/blog/2021-09-06-ved/), or [AKO from Hitachi](https://link.springer.com/content/pdf/10.1007/s10207-020-00514-7.pdf)...try to imagine, what if the attacker has the root privilege of the firmware like OpenBMC? 87 | 88 | Then eveything is over. All your cybersecurity efforts become stupid [Maginot Line](https://en.wikipedia.org/wiki/Maginot_Line). 89 | 90 |
91 | firmware attack 92 |
93 | 94 | The only viable solution is to enhance security at the most fundamental level: the firmware. The Chiba project requires a securely enhanced OpenBMC firmware. While standard APIs are used, the actual OpenBMC firmware is typically customized by hardware vendors. This customization is necessary due to variations in resource definitions and control mechanisms across different vendors. 95 | 96 | Consequently, in real-world product environments, Chiba must be tailored to align with the specific OpenBMC firmware in use, incorporating appropriate security enhancements. This customization requirement opens up opportunities for commercialization. 97 | 98 | ## Design 99 | 100 | Chiba is developed in Guile Scheme, a dialect of Lisp. The Scheme language is chosen for its simplicity and elegance, which makes it easy to understand and maintain. The Scheme language is also a good choice for developing a domain-specific language (DSL) for infrastructure automation. 101 | 102 | ### SCL - Server Configuration Language 103 | 104 | Please refer to the [SCL manual](docs/scl.md) for more details. 105 | 106 | ### Firmware Security Enhancement 107 | 108 | Please refer to the [Firmware Security Enhancement manual](docs/firmware-security-enhancement.md) for more details. 109 | 110 | ### Architecture 111 | 112 |
113 | Chiba Design 114 |
115 | 116 | ## Installation 117 | 118 | [English](docs/install.md) | [日本語](docs/install_jp.md) 119 | 120 | Again, **if you are happen in Tokyo, let's have a coffee.** 121 | 122 | ## License and Authors 123 | 124 | Chiba project is licensed under the GPLv3 license. 125 | 126 | Chiba project is maintaining by [HardenedLinux community](https://hardenedlinux.org). 127 | -------------------------------------------------------------------------------- /conf/artanis.conf: -------------------------------------------------------------------------------- 1 | ## -*- indent-tabs-mode:nil; coding: utf-8 -*- 2 | ## Copyright (C) 2025 3 | ## "Mu Lei" known as "NalaGinrut" 4 | ## Artanis is free software: you can redistribute it and/or modify 5 | ## it under the terms of the GNU General Public License as published by 6 | ## the Free Software Foundation, either version 3 of the License, or 7 | ## (at your option) any later version. 8 | 9 | ## Artanis is distributed in the hope that it will be useful, 10 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | ## GNU General Public License for more details. 13 | 14 | ## You should have received a copy of the GNU General Public License 15 | ## along with this program. If not, see . 16 | 17 | ## --------------------------------------------------------------------- 18 | ## The skeleton of config file, you may modify it on your own purpose. 19 | ## DON'T TYPE `;' AT THE END OF LINE!!! 20 | ## --------------------------------------------------------------------- 21 | 22 | ## Please read the manual or /etc/artanis/default.conf if you have problem 23 | ## to understand these items. 24 | 25 | 26 | ## Whether to use a database, if disabled, the database won't be initialized 27 | ## in the beginning, which saves memory and boot time. 28 | ## Some users may want to use GNU Artanis without configuring any databases, if 29 | ## that's your case please set it to `false' to avoid unintended errors. 30 | ## db.enable = 31 | db.enable = false 32 | 33 | ## What database server should be used, depends on the database installed 34 | ## on your machine. 35 | ## NOTE: If you use MariaDB then you should set it to mysql. 36 | ## db.dbd = mysql | postgresql | sqlite3 37 | db.dbd = mysql 38 | 39 | ## The protocol for connecting the databse. If you use tcp, a socket port 40 | ## must be specified in the address. And if you choose socketfile, then you should 41 | ## specify the unix socket file managed by database server. 42 | ## db.proto = tcp | socketfile 43 | db.proto = tcp 44 | 45 | ## The address of the database server. 46 | ## For example, MariaDB by default uses localhost:3306. 47 | ## db.addr = 48 | db.addr = 127.0.0.1:3306 49 | 50 | ## If you configured the database server to connect to a unix socket file, 51 | ## then you should fill this field with the file name. 52 | ## db.socketfile = 53 | db.socketfile = false 54 | 55 | ## User name to connect to the database server. 56 | ## db.username = 57 | db.username = root 58 | 59 | ## Password of the user to connect to the database server. 60 | ## db.passwd = 61 | db.passwd = 62 | 63 | ## The database name. 64 | ## db.name = 65 | db.name = chiba 66 | 67 | ## The engine of the database server. 68 | ## NOTE: for sqlite3, you must leave this field blank, as `db.engine = ' 69 | ## If you remove this item, the default value InnoDB will be used. 70 | ## db.engine = 71 | db.engine = InnoDB 72 | 73 | ## The size of DB connection pool. If the specified size is less then required, 74 | ## then the task will be scheduled and sleep till there's available DB connection. 75 | ## db.poolsize = 76 | db.poolsize = 64 77 | 78 | ## The management mode of DB connection pool: 79 | ## `increase' for increasing the pool size if any necessary, however it won't reduce back. 80 | ## `fixed' will not increase the pool size, if it lacks of DB connections, then it will 81 | ## be scheduled. 82 | ## db.pool = increase | fixed 83 | db.pool = increase 84 | 85 | ## Whether to encode params automatically. 86 | ## (params rc "your_key") will be encoded by uri-encode. 87 | ## The username and passwd in :auth will be encoded by uri-encode. 88 | ## NOTE: It's your duty to call uri-decode to get proper value. 89 | ## NOTE: If you enable db.encodeparams then it's better to decode the related value 90 | ## twice in the client-side, since some requests may be sent from browsers, and 91 | ## they're already encoded. 92 | ## db.encodeparams = 93 | db.encodeparams = false 94 | 95 | ## Enable LPC (Lightweight Persistent Cache), this may require Redis. 96 | ## db.lpc = 97 | db.lpc = false 98 | 99 | ## Specify your own server info. It'll be Artanis-x.x.x by default, adding 100 | ## the artanis version number. 101 | ## server.info = 102 | server.info = GNU Artanis-1.2.2 103 | 104 | ## If you want to use Nginx for reversed-proxy, please enable it. 105 | ## server.nginx = enable | disable 106 | server.nginx = false 107 | 108 | ## Charset in server side. utf-8 in default. 109 | ## NOTE: Don't change it unless you know what you're doing! 110 | ## server.charset = 111 | server.charset = utf-8 112 | 113 | ## The path of status page. You may customize your own status pages. 114 | ## If you're using application folder from `art create', then you may add your 115 | ## customized status pages in sys/pages, for example, if you create 404.html in 116 | ## sys/pages, then it will overload the original 404 page. 117 | ## server.syspage.path = 118 | server.syspage.path = /etc/artanis/pages 119 | 120 | ## Backlog of the socket. 121 | ## NOTE: Don't change it unless you really know what you're doing! 122 | ## server.backlog = 123 | server.backlog = 128 124 | 125 | ## The length of the work queue in Artanis server. 126 | ## server.wqlen = 127 | server.wqlen = 64 128 | 129 | ## The trigger mode of epoll. Please read epoll man page to know more. 130 | ## server.trigger = edge | level 131 | server.trigger = edge 132 | 133 | ## The server core which is used for holding high concurrent connections. 134 | ## Artanis has a strong server core named Ragnarok, which is based on 135 | ## delimited-continuations to provide asynchronous non-blocking high concurrent serving. 136 | ## You may choose guile inner server which is weak, but useful when you are running 137 | ## Artanis on an operating system lacking key features to run Raganrok. For example, 138 | ## in GNU/Hurd, which has no epoll. 139 | ## You may choose fibers server implemented with threads and delimited continuations, 140 | ## which is preemptable by the timer you set. 141 | ## For more details please see https://github.com/wingo/fibers/wiki/Manual. 142 | ## server.engine = ragnarok | guile | fibers | 143 | server.engine = ragnarok 144 | 145 | ## Timeout for any connection to Artanis (in seconds). 146 | ## 0 for always short live connections. 147 | ## server.timeout = 148 | server.timeout = 60 149 | 150 | ## The the timeout for each event polling round, in miliseconds. 151 | ## server.polltimeout = 152 | server.polltimeout = 500 153 | 154 | ## The buffer size (in bytes) of the connecting socket. 155 | ## In Ragnarok server core, the request handling will be scheduled when the socket 156 | ## buffer is full. This item affects the performance of socket I/O largely. 157 | ## Usually, if you're handling a large amount of small requests, it's better to set 158 | ## the buffer size to a small value. 159 | ## But if you're providing some kind of downloading or uploading service, it's better 160 | ## to set it to a larger one. 161 | ## A large buffer size will increase the latency of unserved requests. 162 | ## Please read the `Ragnarok server core' chapter to learn the design principle, 163 | ## if you need to do some tweaking. 164 | ## server.bufsize = 165 | server.bufsize = 12288 166 | 167 | ## This is the most significant feature of Ragnarok server core. 168 | ## Please remember that there're no threads in GNU Artanis. 169 | ## All the tasks are based on delimited continuations, this kind of design is the 170 | ## so-called Green Threads, or modern terminology, Co-routines. 171 | ## GNU/Linux has introduced a feature named SO_REUSEPORT since 3.9. 172 | ## This feature let us start multiple Artanis instances listening to the same socket 173 | ## port. When requests come, the Linux kernel will do the necessary lock and allocation 174 | ## work for us to dispatch requests to these Artanis instances. 175 | ## server.multi = 176 | server.multi = false 177 | 178 | ## To specify the number of workers in the server core. Each worker implies a coroutine queue. 179 | ## The default value is 1, which means no threading at all. 180 | ## The throughput will be dramatically increased when you set it to a larger number. 181 | ## [Experimental] It's not well tested yet, but it does work. Here're known issues: 182 | ## 1. The main thread may be halted when ctrl+c is pressed, but it still work with other threads. 183 | ## 2. There could be potential race conditions, we've already use parameters for its functional nature 184 | ## to implement thread local storage. But need more tests. 185 | ## NOTE: If the workers is larger than 1, then it implies server.multi = true. 186 | ## server.workers = 187 | server.workers = 1 188 | 189 | ## Enable WebSocket. 190 | ## server.websocket = 191 | server.websocket = true 192 | 193 | ## The path to public directory, this is useful for public static resources, 194 | ## for exaample, css/img/js, etc. 195 | ## server.pub = 196 | server.pub = pub 197 | 198 | ## Whether to use Linux specified sendfile interface. 199 | ## server.sendfile = 200 | server.sendfile = false 201 | 202 | ## Whether to use POSIX specific mmap for file I/O. 203 | ## server.mmapped = 204 | server.mmapped = false 205 | 206 | ## The allowed HTTP methods. 207 | ## server.allowedmethods = 208 | server.allowedmethods = HEAD,GET,POST,PUT 209 | 210 | ## The path to find "manifest.json". 211 | ## server.jsmanifest = 212 | server.jsmanifest = pub 213 | 214 | ## The maximum payload size of WebSocket request in bytes. If it exceeds, then it 215 | ## will be segemented. 216 | ## websocket.maxpayload = 217 | websocket.maxpayload = 18446744073709551615 218 | 219 | ## The minimum payload size of WebSocket request in bytes. 220 | ## Enlarge it to avoid slow 1-byte attack (only for fragment). 221 | ## websocket.minpayload = 222 | websocket.minpayload = 1 223 | 224 | ## If fragment >= 0, then it's the size of the websocket frame fragment. 225 | ## If fragment = 0, then the websocket frame will not be fragmented. 226 | ## websocket.fragment = 227 | websocket.fragment = 4096 228 | 229 | ## Maximum upload size in bytes from WebSocket request, the exceeded request 230 | ## will be fobidden. 231 | ## websocket.maxsize = 232 | websocket.maxsize = 1024 233 | 234 | ## Timeout of WebSocket request, in seconds. 235 | ## websocket.timeout = 236 | websocket.timeout = 64 237 | 238 | ## If disabled, you will have to use the IP address to connect instead of the 239 | ## hostname. e.g. `host.name = artanis.dev'. 240 | ## host.name = | disable 241 | host.name = false 242 | 243 | ## The URL/IP of your hosting site. 244 | ## host.addr = | 245 | host.addr = 127.0.0.1 246 | 247 | ## The listening port of your hosting site. 248 | ## host.port = 249 | host.port = 3000 250 | 251 | ## Specify the protocol family. 252 | ## host.family = ipv4 | ipv6 253 | host.family = ipv4 254 | 255 | ## Detect host or domain-name from specified path. This is useful when you run GNU Artanis inside a container. 256 | ## host.detectpath = | 257 | host.detectpath = false 258 | 259 | ## Specify the session files path. Change according to your session engine. 260 | ## session.path = 261 | session.path = session 262 | 263 | ## Check the valid session, if it appears in multiple client IP, then fail. This may 264 | ## cause problems when your hosting is behind CDN, you may need to disable it if so. 265 | ## session.hijackcheck = 266 | session.hijackcheck = false 267 | 268 | ## Specify session engine. Here're supported backends: 269 | ## simple: uses hash table for memcache. 270 | ## db: uses RDBMS for storing sessions. 271 | ## file: stores session information into text files. 272 | ## redis: uses Redis for managing sessions. 273 | ## session.engine = simple | db | file | redis | redis@addr:port | 274 | session.backend = simple 275 | 276 | ## Specify the i18n engine. Here're supported backends: 277 | ## 1. json: uses json file for i18n. 278 | ## 2. sxml: uses SXML for i18n. 279 | ## 3. locale: uses PO with gettext for i18n. 280 | ## session.i18n = json | sxml | locale | 281 | session.i18n = json 282 | 283 | ## Specify allowed upload file type, say, upload.types = jpg,png,gif. 284 | ## upload.types = 285 | upload.types = jpg,png,gif 286 | 287 | ## The path to put the uploaded files. 288 | ## upload.path = 289 | upload.path = upload 290 | 291 | ## The size limitation of uploaded file in bytes. 292 | ## upload.size = 293 | upload.size = 5242880 294 | 295 | ## The command called by Sendmail module. It's strongly recommended to use `msmtp' to replace `sendmail'. 296 | ## mail.sender = 297 | mail.sender = /usr/bin/msmtp 298 | 299 | ## The maximum age of a cached page in seconds. 300 | ## This is the global maxage of any cache. 301 | ## If you want to specify maxage for certain page, please read the manual about the Cache. 302 | ## cache.maxage = 303 | cache.maxage = 3600 304 | 305 | ## Wheather to enable debug mode. 306 | ## If you enable debug mode, Artanis will print debug information verbosely. 307 | ## The module you modified will be reloaded instantly, and the page view will be rendered as well. 308 | ## NOTE: This option will affect the performance, please use it for debug purposes only./ 309 | ## debug.enable = 310 | debug.enable = false 311 | 312 | ## The paths that needs to be monitored in debug-mode. 313 | ## This will take advantage of `inotify' in GNU/Linux kernel. 314 | ## NOTE: We may support GNU/Hurd as well, with its file monitor mechanism, in the future. 315 | ## debug.monitor = 316 | debug.monitor = 317 | 318 | ## Cookie expiration time in seconds. 319 | ## 1 hour is 3600 320 | ## 6 hours 21600 321 | ## 1 month 2592000 322 | ## cookie.expires = 323 | cookie.expires = 3600 324 | 325 | 326 | ## End Of Artanis conf. 327 | -------------------------------------------------------------------------------- /pub/img/chiba-arch.svg: -------------------------------------------------------------------------------- 1 | Rule EngineChiba CoreSCLAPI GatewaySQLite / RedisRedfish API callingOpenBMCRulesClient 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------