summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Samuelsson <msamuelsson@storvix.eu>2023-02-24 07:31:44 +0100
committerMartin Samuelsson <msamuelsson@storvix.eu>2023-02-24 07:31:44 +0100
commit8ccef7cbe4c11c1638f82e1a9f4a36f5b643551a (patch)
tree007a394219325cf91f522915fbab2a2c1d33769c
downloadlibsyslog-rs-8ccef7cbe4c11c1638f82e1a9f4a36f5b643551a.zip
Initial commit
-rw-r--r--.gitignore2
-rw-r--r--LICENSE-APACHE175
-rw-r--r--LICENSE-MIT19
-rw-r--r--README.md9
-rw-r--r--libsyslog-sys/Cargo.toml9
l---------libsyslog-sys/LICENSE-APACHE1
l---------libsyslog-sys/LICENSE-MIT1
-rw-r--r--libsyslog-sys/README.md21
-rw-r--r--libsyslog-sys/src/lib.rs0
-rw-r--r--libsyslog/Cargo.toml9
l---------libsyslog/LICENSE-APACHE1
l---------libsyslog/LICENSE-MIT1
-rw-r--r--libsyslog/README.md35
-rw-r--r--libsyslog/src/lib.rs0
14 files changed, 283 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a9d37c5
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+target
+Cargo.lock
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..67db858
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,175 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
diff --git a/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..70419cf
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,19 @@
+Copyright 2023 Martin Samuelsson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..798beaf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+This repository c̶o̶n̶t̶a̶i̶n̶s̶ will in a few days, once initial code review has
+passed, contain libsyslog-sys and libsyslog, with the first being the low level
+bindings to [syslog][wikipedia] and the second being the safe Rust bindings
+likely of higher interest for most users.
+
+Please see the README.md files in the corresponding subdirectories for more
+information.
+
+[wikipedia]: https://en.wikipedia.org/wiki/Syslog
diff --git a/libsyslog-sys/Cargo.toml b/libsyslog-sys/Cargo.toml
new file mode 100644
index 0000000..ff5838d
--- /dev/null
+++ b/libsyslog-sys/Cargo.toml
@@ -0,0 +1,9 @@
+[package]
+name = "libsyslog-sys"
+version = "0.0.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+description = "FFI bindings to system's native syslog"
+repository = "https://git.netizen.se/libsyslog-rs"
+keywords = [ "ffi", "logging", "syslog" ]
+categories = [ "external-ffi-bindings", "os" ]
diff --git a/libsyslog-sys/LICENSE-APACHE b/libsyslog-sys/LICENSE-APACHE
new file mode 120000
index 0000000..965b606
--- /dev/null
+++ b/libsyslog-sys/LICENSE-APACHE
@@ -0,0 +1 @@
+../LICENSE-APACHE \ No newline at end of file
diff --git a/libsyslog-sys/LICENSE-MIT b/libsyslog-sys/LICENSE-MIT
new file mode 120000
index 0000000..76219eb
--- /dev/null
+++ b/libsyslog-sys/LICENSE-MIT
@@ -0,0 +1 @@
+../LICENSE-MIT \ No newline at end of file
diff --git a/libsyslog-sys/README.md b/libsyslog-sys/README.md
new file mode 100644
index 0000000..a0e6541
--- /dev/null
+++ b/libsyslog-sys/README.md
@@ -0,0 +1,21 @@
+libsyslog-sys
+=============
+The code (to be publiced shortly) in this crate provides a low level API to the
+system's native syslog, the one typically implemented in C and residing in
+libc.
+
+Most users are likely more interested in the higher level safe API in the
+libsyslog crate.
+
+Contact
+-------
+Please see <https://www.netizen.se/#contact>.
+
+Copyright and License
+---------------------
+This crate is Copyright 2023 Martin Samuelsson. It is distributed under the
+terms of both the MIT license and the Apache License (Version 2.0).
+
+See LICENSE-APACHE and LICENSE-MIT for details.
+
+[libsyslog]: https://lib.rs/crates/libsyslog
diff --git a/libsyslog-sys/src/lib.rs b/libsyslog-sys/src/lib.rs
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/libsyslog-sys/src/lib.rs
diff --git a/libsyslog/Cargo.toml b/libsyslog/Cargo.toml
new file mode 100644
index 0000000..2554477
--- /dev/null
+++ b/libsyslog/Cargo.toml
@@ -0,0 +1,9 @@
+[package]
+name = "libsyslog"
+version = "0.0.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+description = "Rust `log` facade using system's native syslog"
+repository = "https://git.netizen.se/libsyslog-rs"
+keywords = [ "logging", "syslog" ]
+categories = [ "external-ffi-bindings", "os" ]
diff --git a/libsyslog/LICENSE-APACHE b/libsyslog/LICENSE-APACHE
new file mode 120000
index 0000000..965b606
--- /dev/null
+++ b/libsyslog/LICENSE-APACHE
@@ -0,0 +1 @@
+../LICENSE-APACHE \ No newline at end of file
diff --git a/libsyslog/LICENSE-MIT b/libsyslog/LICENSE-MIT
new file mode 120000
index 0000000..76219eb
--- /dev/null
+++ b/libsyslog/LICENSE-MIT
@@ -0,0 +1 @@
+../LICENSE-MIT \ No newline at end of file
diff --git a/libsyslog/README.md b/libsyslog/README.md
new file mode 100644
index 0000000..5b4f64b
--- /dev/null
+++ b/libsyslog/README.md
@@ -0,0 +1,35 @@
+libsyslog
+=========
+The code (to be publiced shortly) in this crate provides an API implementing
+the standard Rust logging facade using the system's syslog. That is, it
+implements the [Log][] trait of the [log] crate for native syslog, typically
+implemented in C and residing in libc.
+
+Why?
+----
+How does this differ from the handful of other pre-existing syslog crates? This
+one uses the system library implementation rather attempting to rewrite it in
+Rust. The hope is thus to have a crate that works on pretty much any platform
+with syslog, avoiding bugs from making assumptions on implementation specific
+details.
+
+The need arose from a desire to use syslog on illumos, a platform where most of
+the other syslog crates fail to even build and other(s) instead fail at
+runtime.
+
+So far this code has only been attempted on illumos. Reports on success or
+failures to use it on other platforms are most welcome.
+
+Contact
+-------
+Please see <https://www.netizen.se/#contact>.
+
+Copyright and License
+---------------------
+This crate is Copyright 2023 Martin Samuelsson. It is distributed under the
+terms of both the MIT license and the Apache License (Version 2.0).
+
+See LICENSE-APACHE and LICENSE-MIT for details.
+
+[Log]: https://docs.rs/log/latest/log/trait.Log.html
+[log]: https://lib.rs/crates/log
diff --git a/libsyslog/src/lib.rs b/libsyslog/src/lib.rs
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/libsyslog/src/lib.rs