diff options
| -rw-r--r-- | Apache-2.0 (renamed from LICENSE) | 0 | ||||
| -rw-r--r-- | CC-BY-SA-3.0 | 354 | ||||
| -rw-r--r-- | CREDITS.md | 10 | ||||
| -rw-r--r-- | LICENSES.md | 23 | ||||
| -rw-r--r-- | README.md | 72 | ||||
| -rw-r--r-- | logo-cynagora-small.png | bin | 11034 -> 26978 bytes | |||
| -rw-r--r-- | logo-cynagora.png | bin | 65942 -> 82240 bytes | |||
| -rw-r--r-- | logo-cynagora.svg | 20 | ||||
| -rw-r--r-- | src/cynagora-protocol.txt | 56 |
9 files changed, 510 insertions, 25 deletions
diff --git a/CC-BY-SA-3.0 b/CC-BY-SA-3.0 new file mode 100644 index 0000000..bf0f938 --- /dev/null +++ b/CC-BY-SA-3.0 @@ -0,0 +1,354 @@ +Creative Commons Attribution-ShareAlike 3.0 Unported + +CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL +SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT +RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" +BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION PROVIDED, +AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE. + +License + +THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE +COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY +COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS +AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. + +BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE +TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE +CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE +IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS. + + 1. Definitions + + a. "Adaptation" means a work based upon the Work, or upon the Work and + other pre-existing works, such as a translation, adaptation, derivative + work, arrangement of music or other alterations of a literary or + artistic work, or phonogram or performance and includes cinematographic + adaptations or any other form in which the Work may be recast, + transformed, or adapted including in any form recognizably derived from + the original, except that a work that constitutes a Collection will + not be considered an Adaptation for the purpose of this License. For + the avoidance of doubt, where the Work is a musical work, performance + or phonogram, the synchronization of the Work in timed-relation with + a moving image ("synching") will be considered an Adaptation for the + purpose of this License. + + b. "Collection" means a collection of literary or artistic works, + such as encyclopedias and anthologies, or performances, phonograms or + broadcasts, or other works or subject matter other than works listed in + Section 1(f) below, which, by reason of the selection and arrangement + of their contents, constitute intellectual creations, in which the Work + is included in its entirety in unmodified form along with one or more + other contributions, each constituting separate and independent works + in themselves, which together are assembled into a collective whole. A + work that constitutes a Collection will not be considered an Adaptation + (as defined below) for the purposes of this License. + + c. "Creative Commons Compatible License" means a license that is + listed at http://creativecommons.org/compatiblelicenses that has been + approved by Creative Commons as being essentially equivalent to this + License, including, at a minimum, because that license: (i) contains + terms that have the same purpose, meaning and effect as the License + Elements of this License; and, (ii) explicitly permits the relicensing + of adaptations of works made available under that license under this + License or a Creative Commons jurisdiction license with the same + License Elements as this License. + + d. "Distribute" means to make available to the public the original and + copies of the Work or Adaptation, as appropriate, through sale or other + transfer of ownership. + + e. "License Elements" means the following high-level license attributes + as selected by Licensor and indicated in the title of this License: + Attribution, ShareAlike. + + f. "Licensor" means the individual, individuals, entity or entities + that offer(s) the Work under the terms of this License. + + g. "Original Author" means, in the case of a literary or artistic + work, the individual, individuals, entity or entities who created the + Work or if no individual or entity can be identified, the publisher; + and in addition (i) in the case of a performance the actors, singers, + musicians, dancers, and other persons who act, sing, deliver, declaim, + play in, interpret or otherwise perform literary or artistic works or + expressions of folklore; (ii) in the case of a phonogram the producer + being the person or legal entity who first fixes the sounds of a + performance or other sounds; and, (iii) in the case of broadcasts, the + organization that transmits the broadcast. + + h. "Work" means the literary and/or artistic work offered under the + terms of this License including without limitation any production + in the literary, scientific and artistic domain, whatever may be + the mode or form of its expression including digital form, such as + a book, pamphlet and other writing; a lecture, address, sermon or + other work of the same nature; a dramatic or dramatico-musical work; a + choreographic work or entertainment in dumb show; a musical composition + with or without words; a cinematographic work to which are assimilated + works expressed by a process analogous to cinematography; a work of + drawing, painting, architecture, sculpture, engraving or lithography; a + photographic work to which are assimilated works expressed by a process + analogous to photography; a work of applied art; an illustration, + map, plan, sketch or three-dimensional work relative to geography, + topography, architecture or science; a performance; a broadcast; + a phonogram; a compilation of data to the extent it is protected + as a copyrightable work; or a work performed by a variety or circus + performer to the extent it is not otherwise considered a literary or + artistic work. + + i. "You" means an individual or entity exercising rights under this + License who has not previously violated the terms of this License + with respect to the Work, or who has received express permission from + the Licensor to exercise rights under this License despite a previous + violation. + + j. "Publicly Perform" means to perform public recitations of the + Work and to communicate to the public those public recitations, by + any means or process, including by wire or wireless means or public + digital performances; to make available to the public Works in such + a way that members of the public may access these Works from a place + and at a place individually chosen by them; to perform the Work to the + public by any means or process and the communication to the public of + the performances of the Work, including by public digital performance; + to broadcast and rebroadcast the Work by any means including signs, + sounds or images. + + k. "Reproduce" means to make copies of the Work by any means including + without limitation by sound or visual recordings and the right of + fixation and reproducing fixations of the Work, including storage of a + protected performance or phonogram in digital form or other electronic + medium. + + 2. Fair Dealing Rights. Nothing in this License is intended to reduce, + limit, or restrict any uses free from copyright or rights arising from + limitations or exceptions that are provided for in connection with the + copyright protection under copyright law or other applicable laws. + + 3. License Grant. Subject to the terms and conditions of this License, + Licensor hereby grants You a worldwide, royalty-free, non-exclusive, + perpetual (for the duration of the applicable copyright) license to + exercise the rights in the Work as stated below: + + a. to Reproduce the Work, to incorporate the Work into one or + more Collections, and to Reproduce the Work as incorporated in the + Collections; + + b. to create and Reproduce Adaptations provided that any such + Adaptation, including any translation in any medium, takes reasonable + steps to clearly label, demarcate or otherwise identify that changes + were made to the original Work. For example, a translation could be + marked "The original work was translated from English to Spanish," or a + modification could indicate "The original work has been modified."; + + c. to Distribute and Publicly Perform the Work including as + incorporated in Collections; and, + + d. to Distribute and Publicly Perform Adaptations. + + e. For the avoidance of doubt: + + i. Non-waivable Compulsory License Schemes. In those jurisdictions + in which the right to collect royalties through any statutory or + compulsory licensing scheme cannot be waived, the Licensor reserves + the exclusive right to collect such royalties for any exercise by + You of the rights granted under this License; + + ii. Waivable Compulsory License Schemes. In those jurisdictions + in which the right to collect royalties through any statutory or + compulsory licensing scheme can be waived, the Licensor waives the + exclusive right to collect such royalties for any exercise by You + of the rights granted under this License; and, + + iii. Voluntary License Schemes. The Licensor waives the right + to collect royalties, whether individually or, in the event that + the Licensor is a member of a collecting society that administers + voluntary licensing schemes, via that society, from any exercise by + You of the rights granted under this License. + + The above rights may be exercised in all media and formats whether now + known or hereafter devised. The above rights include the right to make + such modifications as are technically necessary to exercise the rights in + other media and formats. Subject to Section 8(f), all rights not expressly + granted by Licensor are hereby reserved. + + 4. Restrictions. The license granted in Section 3 above is expressly made + subject to and limited by the following restrictions: + + a. You may Distribute or Publicly Perform the Work only under the + terms of this License. You must include a copy of, or the Uniform + Resource Identifier (URI) for, this License with every copy of the + Work You Distribute or Publicly Perform. You may not offer or impose + any terms on the Work that restrict the terms of this License or the + ability of the recipient of the Work to exercise the rights granted to + that recipient under the terms of the License. You may not sublicense + the Work. You must keep intact all notices that refer to this License + and to the disclaimer of warranties with every copy of the Work You + Distribute or Publicly Perform. When You Distribute or Publicly Perform + the Work, You may not impose any effective technological measures on + the Work that restrict the ability of a recipient of the Work from You + to exercise the rights granted to that recipient under the terms of + the License. This Section 4(a) applies to the Work as incorporated in + a Collection, but this does not require the Collection apart from the + Work itself to be made subject to the terms of this License. If You + create a Collection, upon notice from any Licensor You must, to the + extent practicable, remove from the Collection any credit as required + by Section 4(c), as requested. If You create an Adaptation, upon notice + from any Licensor You must, to the extent practicable, remove from the + Adaptation any credit as required by Section 4(c), as requested. + + b. You may Distribute or Publicly Perform an Adaptation only under + the terms of: (i) this License; (ii) a later version of this License + with the same License Elements as this License; (iii) a Creative + Commons jurisdiction license (either this or a later license + version) that contains the same License Elements as this License + (e.g., Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons + Compatible License. If you license the Adaptation under one of the + licenses mentioned in (iv), you must comply with the terms of that + license. If you license the Adaptation under the terms of any of the + licenses mentioned in (i), (ii) or (iii) (the "Applicable License"), + you must comply with the terms of the Applicable License generally + and the following provisions: (I) You must include a copy of, or the + URI for, the Applicable License with every copy of each Adaptation + You Distribute or Publicly Perform; (II) You may not offer or impose + any terms on the Adaptation that restrict the terms of the Applicable + License or the ability of the recipient of the Adaptation to exercise + the rights granted to that recipient under the terms of the Applicable + License; (III) You must keep intact all notices that refer to the + Applicable License and to the disclaimer of warranties with every copy + of the Work as included in the Adaptation You Distribute or Publicly + Perform; (IV) when You Distribute or Publicly Perform the Adaptation, + You may not impose any effective technological measures on the + Adaptation that restrict the ability of a recipient of the Adaptation + from You to exercise the rights granted to that recipient under the + terms of the Applicable License. This Section 4(b) applies to the + Adaptation as incorporated in a Collection, but this does not require + the Collection apart from the Adaptation itself to be made subject to + the terms of the Applicable License. + + c. If You Distribute, or Publicly Perform the Work or any Adaptations + or Collections, You must, unless a request has been made pursuant + to Section 4(a), keep intact all copyright notices for the Work and + provide, reasonable to the medium or means You are utilizing: (i) the + name of the Original Author (or pseudonym, if applicable) if supplied, + and/or if the Original Author and/or Licensor designate another party + or parties (e.g., a sponsor institute, publishing entity, journal) + for attribution ("Attribution Parties") in Licensor's copyright + notice, terms of service or by other reasonable means, the name of + such party or parties; (ii) the title of the Work if supplied; (iii) + to the extent reasonably practicable, the URI, if any, that Licensor + specifies to be associated with the Work, unless such URI does not + refer to the copyright notice or licensing information for the Work; + and (iv), consistent with Section 3(b), in the case of an Adaptation, + a credit identifying the use of the Work in the Adaptation (e.g., + "French translation of the Work by Original Author," or "Screenplay + based on original Work by Original Author"). The credit required + by this Section 4(c) may be implemented in any reasonable manner; + provided, however, that in the case of a Adaptation or Collection, + at a minimum such credit will appear, if a credit for all contributing + authors of the Adaptation or Collection appears, then as part of these + credits and in a manner at least as prominent as the credits for the + other contributing authors. For the avoidance of doubt, You may only + use the credit required by this Section for the purpose of attribution + in the manner set out above and, by exercising Your rights under this + License, You may not implicitly or explicitly assert or imply any + connection with, sponsorship or endorsement by the Original Author, + Licensor and/or Attribution Parties, as appropriate, of You or Your use + of the Work, without the separate, express prior written permission of + the Original Author, Licensor and/or Attribution Parties. + + d. Except as otherwise agreed in writing by the Licensor or as may be + otherwise permitted by applicable law, if You Reproduce, Distribute + or Publicly Perform the Work either by itself or as part of any + Adaptations or Collections, You must not distort, mutilate, modify + or take other derogatory action in relation to the Work which would + be prejudicial to the Original Author's honor or reputation. Licensor + agrees that in those jurisdictions (e.g. Japan), in which any exercise + of the right granted in Section 3(b) of this License (the right to + make Adaptations) would be deemed to be a distortion, mutilation, + modification or other derogatory action prejudicial to the Original + Author's honor and reputation, the Licensor will waive or not assert, + as appropriate, this Section, to the fullest extent permitted by the + applicable national law, to enable You to reasonably exercise Your + right under Section 3(b) of this License (right to make Adaptations) + but not otherwise. + + 5. Representations, Warranties and Disclaimer + + UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR + OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY + KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, + INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, + FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT + OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER + OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF + IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU. + + 6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE + LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY + SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING + OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + + 7. Termination + + a. This License and the rights granted hereunder will terminate + automatically upon any breach by You of the terms of this + License. Individuals or entities who have received Adaptations or + Collections from You under this License, however, will not have their + licenses terminated provided such individuals or entities remain in + full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will + survive any termination of this License. + + b. Subject to the above terms and conditions, the license granted + here is perpetual (for the duration of the applicable copyright in + the Work). Notwithstanding the above, Licensor reserves the right to + release the Work under different license terms or to stop distributing + the Work at any time; provided, however that any such election will not + serve to withdraw this License (or any other license that has been, or + is required to be, granted under the terms of this License), and this + License will continue in full force and effect unless terminated as + stated above. + + 8. Miscellaneous + + a. Each time You Distribute or Publicly Perform the Work or a + Collection, the Licensor offers to the recipient a license to the Work + on the same terms and conditions as the license granted to You under + this License. + + b. Each time You Distribute or Publicly Perform an Adaptation, Licensor + offers to the recipient a license to the original Work on the same + terms and conditions as the license granted to You under this License. + + c. If any provision of this License is invalid or unenforceable under + applicable law, it shall not affect the validity or enforceability of + the remainder of the terms of this License, and without further action + by the parties to this agreement, such provision shall be reformed + to the minimum extent necessary to make such provision valid and + enforceable. + + d. No term or provision of this License shall be deemed waived and no + breach consented to unless such waiver or consent shall be in writing + and signed by the party to be charged with such waiver or consent. + + e. This License constitutes the entire agreement between the parties + with respect to the Work licensed here. There are no understandings, + agreements or representations with respect to the Work not specified + here. Licensor shall not be bound by any additional provisions that may + appear in any communication from You. This License may not be modified + without the mutual written agreement of the Licensor and You. + + f. The rights granted under, and the subject matter referenced, in this + License were drafted utilizing the terminology of the Berne Convention + for the Protection of Literary and Artistic Works (as amended on + September 28, 1979), the Rome Convention of 1961, the WIPO Copyright + Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and + the Universal Copyright Convention (as revised on July 24, 1971). These + rights and subject matter take effect in the relevant jurisdiction + in which the License terms are sought to be enforced according to + the corresponding provisions of the implementation of those treaty + provisions in the applicable national law. If the standard suite of + rights granted under applicable copyright law includes additional + rights not granted under this License, such additional rights are + deemed to be included in the License; this License is not intended to + restrict the license of any rights under applicable law. + @@ -1,9 +1,3 @@ -Thanks to Manassas for the logo (see below) +Thanks to Samsung Poland R&D team for the concepts of cynara. +Thanks to "Manassas" of wikipedia (a pseudo?) for the logo (see LICENSE) -LOGO ----- - -The logo is derived from the blason of Nancy (France) as created by Manassas: - "Manassas Image created for the Blazon Project of the French Wikipedia. - [CC BY-SA 3.0 (https://creativecommons.org/licenses/by-sa/3.0)]" -So the logo is also available using the same license. diff --git a/LICENSES.md b/LICENSES.md new file mode 100644 index 0000000..d6b140a --- /dev/null +++ b/LICENSES.md @@ -0,0 +1,23 @@ +The work found here is distributed under the terms of the license Apache-2.0 +with the exception of the logo that is disctibuted under the terms of the +license CC-BY-SA-3.0 (see below). + +The license Apache-2.0 can be found on web at URL + http://www.apache.org/licenses/LICENSE-2.0 +A copy is provided here file `Apache-2.0` + +LOGO +---- + +The logo is derived from the blason of Nancy (France) as created by Manassas: + `Manassas Image created for the Blazon Project of the French Wikipedia. + [CC BY-SA 3.0 (https://creativecommons.org/licenses/by-sa/3.0)]` +See https://commons.wikimedia.org/wiki/File:Blason_Nancy_54.svg. + +So the logo files used for cynagora are also available using the same license: + https://creativecommons.org/licenses/by/3.0/legalcode +A copy can be found here, file `CC-BY-SA-3.0` + +Files covered by this license are: `logo-cynagora.png`, `logo-cynagora-small.png` +and `logo-cynagora.svg`. + @@ -34,10 +34,31 @@ In facts, the keys can be used with other values that the one primarily designed. For example, using the pid for the session is not safe. So it can be replaced with a string really identifying a session. -The database of *cynagora* is made of rules that set permissions +The database of *cynagora* is made of rules. Each cynagora rule is +a tuple of five strings and one integer: + + (CLIENT, SESSION, USER, PERMISSION, RESULT, EXPIRE). + +The strings `CLIENT`, `SESSION`, `USER`, `PERMISSION` are arbitrary. +They can also have the special value `*` (STAR) that means that the rule +matches any value. Otherwise, the rule matches a query only if the +value matches the string of the rule. That match is: + + - case sensitive for CLIENT, SESSION, USER + - case insensitive for PERMISSION + +The string RESULT has basically one of the two values `yes` or `no`. It can +also be an agent item that will imply a request to an existing agent. Cynagora implements handles differently the rules targeting any sessions -and the rules targeting specific sessions. +and the rules targeting specific sessions. The rules that have SESSION equals +to `*` are stored persistentely in the filesystem. That rule whose SESSION +is not STAR are volatile and only reside in memory. + +Expiration is a 64 bits signed integer that express the date of expiration +of the rule in epoch (number of seconds since 1 January 1970). The special +value 0 means no expiration, permanent rule. The negative values are used +to avoid caching, their expiration value is given by the formula `-(1 + x)`. ## API Overview @@ -56,12 +77,24 @@ Cynagora is a refit of [cynara][2] that allows inclusion of expirations. It implements the same permission database by principle but the details changes. +As a possible replacement, cynagora can supply a simple compatibility +library that offers light legacy API of cynara. This would allow to run +simple cynara clients (admin/check/async-check but not agents) without +changes. + # Compiling -The compilation use the build system *cmake*. Cynagora has no dependencies. -However, it can be built for using it with systemd activation. In that +Cynagora is written in language C. + +Cynagora only depends of _libcap_ that is used by the cynagora server. + +The server can be built for using systemd socket activation. In that case it requires _lisystemd_. +## Compiling with cmake and make + +The compilation use the build system *cmake*. + Example for compiling and installing cynagora: mkdir build @@ -73,9 +106,6 @@ Options to pass to cmake: - *WITH_SYSTEMD*: flag for generating systemd compatible units (default ON) - - *WITH_CYNARA_COMPAT*: flag for producing cynara compatibility artifacts - (default OFF) - - *DEFAULT_DB_DIR*: path of the directory for the database (default ${CMAKE_INSTALL_FULL_LOCALSTATEDIR}/lib/cynagora) @@ -85,15 +115,37 @@ Options to pass to cmake: - *DEFAULT_INIT_FILE*: path to the initialization file to use (default ${CMAKE_INSTALL_FULL_SYSCONFDIR}/security/cynagora.initial) + - *WITH_CYNARA_COMPAT*: flag for producing cynara compatibility artifacts + (default OFF) + + - *DIRECT_CYNARA_COMPAT*: if true, dont use the shared client library to + access cynara server but use the static library instead, avoid a dependency + to the shared library. + Example: cmake -DCMAKE_INSTALL_PREFIX=~/.local -DWITH_SYSTEMD=OFF .. + make install + +## Compiling with meson and ninja + +You can compile using meson. Example: + + meson --prefix ~/.local -Dwith-systemd=false setup build + ninja -C build install + +Option are the same that above except that they are in lower case with dash: +*with-systemd*, *with-cynara-compat*, *direct-cynara-compat*. + +# Licenses -# License +Cynagora is licensed under a Apache License Version 2.0, January 2004, +available on [Apache website][3] or in Apache-2.0 file. -Cynagora is licensed under a Apache License Version 2.0, January 2004. -Available on Apache [website][3] or in LICENSE file. +Logo is licensed under Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0), +avaliable on [creative commons website][4] or in CC-BY-SA-3.0 file. [1]: https://git.automotivelinux.org/src/cynagora/ [2]: https://wiki.tizen.org/wiki/Security:Cynara [3]: https://www.apache.org/licenses/LICENSE-2.0 +[4]: https://creativecommons.org/licenses/by-sa/3.0/ diff --git a/logo-cynagora-small.png b/logo-cynagora-small.png Binary files differindex 14e9241..e7593a2 100644 --- a/logo-cynagora-small.png +++ b/logo-cynagora-small.png diff --git a/logo-cynagora.png b/logo-cynagora.png Binary files differindex 1fb9d43..dac2a8f 100644 --- a/logo-cynagora.png +++ b/logo-cynagora.png diff --git a/logo-cynagora.svg b/logo-cynagora.svg index 79fd52e..c00e35c 100644 --- a/logo-cynagora.svg +++ b/logo-cynagora.svg @@ -17,6 +17,8 @@ sodipodi:docname="logo-cynagora.svg" inkscape:output_extension="org.inkscape.output.svg.inkscape" version="1.0"> + <title + id="title36">logo cynagora</title> <metadata id="metadata28"> <rdf:RDF> @@ -25,7 +27,19 @@ <dc:format>image/svg+xml</dc:format> <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> - <dc:title></dc:title> + <dc:title>logo cynagora</dc:title> + <dc:creator> + <cc:Agent> + <dc:title>manassas</dc:title> + </cc:Agent> + </dc:creator> + <dc:rights> + <cc:Agent> + <dc:title>CC-BY-SA-3.0</dc:title> + </cc:Agent> + </dc:rights> + <cc:license + rdf:resource="https://creativecommons.org/licenses/by/3.0/legalcode" /> </cc:Work> </rdf:RDF> </metadata> @@ -43,8 +57,8 @@ id="base" showgrid="false" inkscape:zoom="1.1621212" - inkscape:cx="156.58139" - inkscape:cy="13.07222" + inkscape:cx="-21.971415" + inkscape:cy="10.060486" inkscape:window-x="0" inkscape:window-y="31" inkscape:current-layer="layer3" diff --git a/src/cynagora-protocol.txt b/src/cynagora-protocol.txt index bf255d9..ea3c1c2 100644 --- a/src/cynagora-protocol.txt +++ b/src/cynagora-protocol.txt @@ -8,10 +8,15 @@ Introduction - c->s: from client to cynagora server - s->c: from cynagora server to client - - EXPIRE: if missing, means forever - if positive, a number of second since EPOCH, invalid after it - CACHEID: a 32 bits positive integer - ID: a string + - EXPIRE: if missing, means: can cache forever + if '-', means: don't cache + if TIMESPEC (see below), means: valid until given relative time + - SEXPIRE: Same as EXPIRE but also allows TIMESPEC prefixed with '-', meaning + valid until given relative time and don't cache + +For TIMESPEC see notes. Messages -------- @@ -49,6 +54,8 @@ synopsis: c->s test ID CLIENT SESSION USER PERMISSION s->c (ack|yes|no) ID [EXPIRE] +Check whether the permission is granted (yes) or not granted (no) +or undecidable without querying an agent (ack). ### check a permission @@ -58,6 +65,8 @@ synopsis: c->s check ID CLIENT SESSION USER PERMISSION s->c (yes|no) ID [EXPIRE] +Check whether the permission is granted (yes) or not granted (no) and invoke +agent if needed. ### enter critical (admin) @@ -67,6 +76,9 @@ synopsis: c->s enter s->c done +Start modifications (prior to set or drop). + + ### leave critical (admin) synopsis: @@ -74,6 +86,9 @@ synopsis: c->s leave [commit|rollback] s->c done|error ... +Terminate modifications and commit it (commit) or cancel it (rollback). + + ### erase (admin) synopsis: @@ -81,22 +96,31 @@ synopsis: c->s drop CLIENT SESSION USER PERMISSION s->c done|error ... +Drop the rule matching the given filter. + + ### set (admin) synopsis: - c->s set CLIENT SESSION USER PERMISSION VALUE [EXPIRE] + c->s set CLIENT SESSION USER PERMISSION VALUE [SEXPIRE] s->c done|error ... +Create the rule as given. + + ### list permissions (admin): synopsis: c->s get CLIENT SESSION USER PERMISSION - s->c item CLIENT SESSION USER PERMISSION VALUE [EXPIRE] + s->c item CLIENT SESSION USER PERMISSION VALUE [SEXPIRE] s->c ... s->c done +List the rules matching the given filter. + + ### logging set/get (admin) synopsis: @@ -104,6 +128,9 @@ synopsis: c->s log [on|off] s->c done (on|off) +Tell to log or not the queries or query the current state. + + ### register agent (agent) synopsis: @@ -111,6 +138,9 @@ synopsis: c->s agent NAME s->c done|error ... +Register the agent of NAME + + ### ask agent (agent): synopsis: @@ -118,6 +148,9 @@ synopsis: s->c ask ASKID NAME VALUE CLIENT SESSION USER PERMISSION c->s reply ASKID ([yes|no] [always|session|one-time|EXPIRE]) +Receive an agent resolution request. + + ### sub check (agent): synopsis: @@ -125,9 +158,24 @@ synopsis: c->s sub ASKID ID CLIENT SESSION USER PERMISSION s->c (yes|no) ID [EXPIRE] +Make a check in the context of an agent resolution. + + Notes ----- +### TIMESPEC + +The TIMESPEC describe a number of seconds in the futur relative to now. +It can be a simple decimal integer. I can also use letters to designate +year (letter `y`), week (letter `w`), day (letter `d`), hour (letter `h`), +minute (letter `m`), second (letter `s`). + +Examples: + + - 15d + + ### CACHEID The cacheid identify the current cache. It changes each time the database |
