build: bump version to 0.7.2

docs: add Cargo package metadata
improvement: build auditable binary in docker
2022-11-19 07:55:52 -06:00 · 2022-11-19 07:32:17 -06:00 · 2022-11-19 07:11:39 -06:00 · 2022-11-19 06:52:06 -06:00 · 2022-11-19 06:29:13 -06:00 · 2022-11-12 09:22:43 -06:00
10 changed files with 150 additions and 88 deletions
@@ -200,9 +200,9 @@ checksum = "ec8a7b6a70fde80372154c65702f00a0f56f3e1c36abbc6c440484be248856db"

 [[package]]
 name = "cc"
-version = "1.0.74"
+version = "1.0.76"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "581f5dba903aac52ea3feb5ec4810848460ee833876f1f9b0fdeab1f19091574"
+checksum = "76a284da2e6fe2092f2353e51713435363112dfd60030e22add80be333fb928f"

 [[package]]
 name = "cfg-if"
@@ -212,9 +212,9 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"

 [[package]]
 name = "chrono"
-version = "0.4.22"
+version = "0.4.23"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bfd4d1b31faaa3a89d7934dbded3111da0d2ef28e3ebccdb4f0179f5929d1ef1"
+checksum = "16b0a3d9ed01224b22057780a37bb8c5dbfe1be8ba48678e7bf57ec4b385411f"
 dependencies = [
 "iana-time-zone",
 "num-integer",
@@ -381,9 +381,9 @@ dependencies = [

 [[package]]
 name = "cxx"
-version = "1.0.80"
+version = "1.0.82"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6b7d4e43b25d3c994662706a1d4fcfc32aaa6afd287502c111b237093bb23f3a"
+checksum = "d4a41a86530d0fe7f5d9ea779916b7cadd2d4f9add748b99c2c029cbbdfaf453"
 dependencies = [
 "cc",
 "cxxbridge-flags",
@@ -393,9 +393,9 @@ dependencies = [

 [[package]]
 name = "cxx-build"
-version = "1.0.80"
+version = "1.0.82"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "84f8829ddc213e2c1368e51a2564c552b65a8cb6a28f31e576270ac81d5e5827"
+checksum = "06416d667ff3e3ad2df1cd8cd8afae5da26cf9cec4d0825040f88b5ca659a2f0"
 dependencies = [
 "cc",
 "codespan-reporting",
@@ -408,15 +408,15 @@ dependencies = [

 [[package]]
 name = "cxxbridge-flags"
-version = "1.0.80"
+version = "1.0.82"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e72537424b474af1460806647c41d4b6d35d09ef7fe031c5c2fa5766047cc56a"
+checksum = "820a9a2af1669deeef27cb271f476ffd196a2c4b6731336011e0ba63e2c7cf71"

 [[package]]
 name = "cxxbridge-macro"
-version = "1.0.80"
+version = "1.0.82"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "309e4fb93eed90e1e14bea0da16b209f81813ba9fc7830c20ed151dd7bc0a4d7"
+checksum = "a08a6e2fcc370a089ad3b4aaf54db3b1b4cee38ddabce5896b33eb693275f470"
 dependencies = [
 "proc-macro2",
 "quote",
@@ -438,9 +438,9 @@ dependencies = [

 [[package]]
 name = "digest"
-version = "0.10.5"
+version = "0.10.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "adfbc57365a37acbd2ebf2b64d7e69bb766e2fea813521ed536f5d0520dcf86c"
+checksum = "8168378f4e5023e7218c89c891c0fd8ecdb5e5e4f18cb78f38cf245dd021e76f"
 dependencies = [
 "block-buffer",
 "crypto-common",
@@ -789,9 +789,9 @@ checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4"

 [[package]]
 name = "hyper"
-version = "0.14.22"
+version = "0.14.23"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "abfba89e19b959ca163c7752ba59d737c1ceea53a5d31a149c805446fc958064"
+checksum = "034711faac9d2166cb1baf1a2fb0b60b1f277f8492fd72176c17f3515e1abd3c"
 dependencies = [
 "bytes",
 "futures-channel",
@@ -872,9 +872,9 @@ dependencies = [

 [[package]]
 name = "indexmap"
-version = "1.9.1"
+version = "1.9.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "10a35a97730320ffe8e2d410b5d3b69279b98d2c14bdb8b70ea89ecf7888d41e"
+checksum = "1885e79c1fc4b10f0e172c475f458b7f7b93061064d98c3293e98c5ba0c8b399"
 dependencies = [
 "autocfg 1.1.0",
 "hashbrown 0.12.3",
@@ -1095,7 +1095,7 @@ checksum = "38bf9645c8b145698bb0b18a4637dcacbc421ea49bef2317e4fd8065a387cf21"

 [[package]]
 name = "nostr-rs-relay"
-version = "0.7.1"
+version = "0.7.2"
 dependencies = [
 "anyhow",
 "bitcoin_hashes",
@@ -1664,9 +1664,9 @@ dependencies = [

 [[package]]
 name = "regex"
-version = "1.6.0"
+version = "1.7.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4c4eb3267174b8c6c2f654116623910a0fef09c4753f8dd83db29c48a0df988b"
+checksum = "e076559ef8e241f2ae3479e36f97bd5741c0330689e217ad51ce2c76808b868a"
 dependencies = [
 "aho-corasick",
 "memchr",
@@ -1684,9 +1684,9 @@ dependencies = [

 [[package]]
 name = "regex-syntax"
-version = "0.6.27"
+version = "0.6.28"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a3f87b73ce11b1619a3c6332f45341e0047173771e8b8b73f87bfeefb7b56244"
+checksum = "456c603be3e8d448b072f410900c09faf164fbce2d480456f50eea6e25f9c848"

 [[package]]
 name = "remove_dir_all"
@@ -1836,9 +1836,9 @@ dependencies = [

 [[package]]
 name = "serde_json"
-version = "1.0.87"
+version = "1.0.88"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6ce777b7b150d76b9cf60d28b55f5847135a003f7d7350c6be7a773508ce7d45"
+checksum = "8e8b3801309262e8184d9687fb697586833e939767aea0dda89f5a8e650e8bd7"
 dependencies = [
 "indexmap",
 "itoa",
@@ -1997,9 +1997,9 @@ checksum = "cda74da7e1a664f795bb1f8a87ec406fb89a02522cf6e50620d016add6dbbf5c"

 [[package]]
 name = "tokio"
-version = "1.21.2"
+version = "1.22.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a9e03c497dc955702ba729190dc4aac6f2a0ce97f913e5b1b5912fc5039d9099"
+checksum = "d76ce4a75fb488c605c54bf610f221cea8b0dafb53333c1a67e8ee199dcd2ae3"
 dependencies = [
 "autocfg 1.1.0",
 "bytes",
@@ -2367,9 +2367,9 @@ checksum = "09cc8ee72d2a9becf2f2febe0205bbed8fc6615b7cb429ad062dc7b7ddd036a9"

 [[package]]
 name = "uuid"
-version = "1.2.1"
+version = "1.2.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "feb41e78f93363bb2df8b0e86a2ca30eed7806ea16ea0c790d757cf93f79be83"
+checksum = "422ee0de9031b5b948b97a8fc04e3aa35230001a722ddd27943e0be31564ce4c"
 dependencies = [
 "getrandom",
 ]
@@ -1,7 +1,15 @@
 [package]
 name = "nostr-rs-relay"
-version = "0.7.1"
+version = "0.7.2"
 edition = "2021"
+authors = ["Greg Heartsfield <scsibug@imap.cc>"]
+description = "A relay implementation for the Nostr protocol"
+readme = "README.md"
+homepage = "https://sr.ht/~gheartsfield/nostr-rs-relay/"
+repository = "https://git.sr.ht/~gheartsfield/nostr-rs-relay"
+license = "MIT"
+keywords = ["nostr", "server"]
+categories = ["network-programming", "web-programming"]

 [dependencies]
 tracing = "0.1.36"
@@ -1,16 +1,21 @@
 FROM docker.io/library/rust:1.65.0@sha256:1bca14676a365d0ed37a1e2a1da86c2bcf883fdf6e6886469434763d94d4afd5 as builder

+RUN USER=root cargo install cargo-auditable
 RUN USER=root cargo new --bin nostr-rs-relay
 WORKDIR ./nostr-rs-relay
 COPY ./Cargo.toml ./Cargo.toml
 COPY ./Cargo.lock ./Cargo.lock
-RUN cargo build --release
+# build dependencies only (caching)
+RUN cargo auditable build --release --locked
+# get rid of starter project code
 RUN rm src/*.rs

+# copy project source code
 COPY ./src ./src

+# build auditable release using locked deps
 RUN rm ./target/release/deps/nostr*relay*
-RUN cargo build --release
+RUN cargo auditable build --release --locked

 FROM docker.io/library/debian:bullseye-20221024-slim@sha256:76cdda8fe5eb597ef5e712e4c9a9f5f1fb119e69f353daaa7bd6d0f6e66e541d

@@ -26,6 +26,7 @@ mirrored on [GitHub](https://github.com/scsibug/nostr-rs-relay).
 - [x] NIP-12: [Generic Tag Queries](https://github.com/nostr-protocol/nips/blob/master/12.md)
 - [x] NIP-15: [End of Stored Events Notice](https://github.com/nostr-protocol/nips/blob/master/15.md)
 - [x] NIP-16: [Event Treatment](https://github.com/nostr-protocol/nips/blob/master/16.md)
+- [x] NIP-20: [Command Results](https://github.com/nostr-protocol/nips/blob/master/20.md)
 - [x] NIP-22: [Event `created_at` limits](https://github.com/nostr-protocol/nips/blob/master/22.md) (_future-dated events only_)
 - [x] NIP-26: [Event Delegation](https://github.com/nostr-protocol/nips/blob/master/26.md)

@@ -159,8 +159,9 @@ pub async fn db_writer(
                        event.get_event_id_prefix()
                    );
                    notice_tx
-                        .try_send(Notice::message(
-                            "pubkey is not allowed to publish to this relay".to_owned(),
+                        .try_send(Notice::blocked(
+                            event.id,
+                            "pubkey is not allowed to publish to this relay",
                        ))
                        .ok();
                    continue;
@@ -192,9 +193,9 @@ pub async fn db_writer(
                                  event.get_author_prefix()
                            );
                            notice_tx
-                                .try_send(Notice::message(
-                                    "NIP-05 verification is no longer valid (expired/wrong domain)"
-                                        .to_owned(),
+                                .try_send(Notice::blocked(
+                                    event.id,
+                                    "NIP-05 verification is no longer valid (expired/wrong domain)",
                                ))
                                .ok();
                            continue;
@@ -206,8 +207,9 @@ pub async fn db_writer(
                            event.get_author_prefix()
                        );
                        notice_tx
-                            .try_send(Notice::message(
-                                "NIP-05 verification needed to publish events".to_owned(),
+                            .try_send(Notice::blocked(
+                                event.id,
+                                "NIP-05 verification needed to publish events",
                            ))
                            .ok();
                        continue;
@@ -250,9 +252,8 @@ pub async fn db_writer(
                    }
                    Err(err) => {
                        warn!("event insert failed: {:?}", err);
-                        let msg =
-                            "relay experienced an error trying to publish the latest event".into();
-                        notice_tx.try_send(Notice::err_msg(msg, event.id)).ok();
+                        let msg = "relay experienced an error trying to publish the latest event";
+                        notice_tx.try_send(Notice::error(event.id, msg)).ok();
                    }
                }
            }
@@ -17,10 +17,16 @@ pub enum Error {
    ConnWriteError,
    #[error("EVENT parse failed")]
    EventParseFailed,
-    #[error("ClOSE message parse failed")]
+    #[error("CLOSE message parse failed")]
    CloseParseFailed,
-    #[error("Event validation failed")]
-    EventInvalid,
+    #[error("Event invalid signature")]
+    EventInvalidSignature,
+    #[error("Event invalid id")]
+    EventInvalidId,
+    #[error("Event malformed pubkey")]
+    EventMalformedPubkey,
+    #[error("Event could not canonicalize")]
+    EventCouldNotCanonicalize,
    #[error("Event too large")]
    EventMaxLengthError(usize),
    #[error("Subscription identifier max length exceeded")]
@@ -27,6 +27,12 @@ pub struct EventCmd {
    event: Event,
 }

+impl EventCmd {
+    pub fn event_id(&self) -> &str {
+        &self.event.id
+    }
+}
+
 /// Parsed nostr event.
 #[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
 pub struct Event {
@@ -83,13 +89,13 @@ impl From<EventCmd> for Result<Event> {
        // ensure command is correct
        if ec.cmd != "EVENT" {
            Err(CommandUnknownError)
-        } else if ec.event.is_valid() {
+        } else {
+            ec.event.validate().map(|_| {
                let mut e = ec.event;
                e.build_index();
                e.update_delegation();
-            Ok(e)
-        } else {
-            Err(EventInvalid)
+                e
+            })
        }
    }
 }
@@ -220,7 +226,7 @@ impl Event {
    }

    /// Check if this event has a valid signature.
-    fn is_valid(&self) -> bool {
+    fn validate(&self) -> Result<()> {
        // TODO: return a Result with a reason for invalid events
        // validation is performed by:
        // * parsing JSON string into event fields
@@ -229,8 +235,8 @@ impl Event {
        // * serialize with no spaces/newlines
        let c_opt = self.to_canonical();
        if c_opt.is_none() {
-            debug!("event could not be canonicalized");
-            return false;
+            debug!("could not canonicalize");
+            return Err(EventCouldNotCanonicalize);
        }
        let c = c_opt.unwrap();
        // * compute the sha256sum.
@@ -239,21 +245,21 @@ impl Event {
        // * ensure the id matches the computed sha256sum.
        if self.id != hex_digest {
            debug!("event id does not match digest");
-            return false;
+            return Err(EventInvalidId);
        }
        // * validate the message digest (sig) using the pubkey & computed sha256 message hash.
        let sig = schnorr::Signature::from_str(&self.sig).unwrap();
        if let Ok(msg) = secp256k1::Message::from_slice(digest.as_ref()) {
            if let Ok(pubkey) = XOnlyPublicKey::from_str(&self.pubkey) {
-                let verify = SECP.verify_schnorr(&sig, &msg, &pubkey);
-                matches!(verify, Ok(()))
+                SECP.verify_schnorr(&sig, &msg, &pubkey)
+                    .map_err(|_| EventInvalidSignature)
            } else {
                debug!("client sent malformed pubkey");
-                false
+                Err(EventMalformedPubkey)
            }
        } else {
            info!("error converting digest to secp256k1 message");
-            false
+            Err(EventInvalidSignature)
        }
    }

@@ -35,7 +35,7 @@ impl From<config::Info> for RelayInfo {
            description: i.description,
            pubkey: i.pubkey,
            contact: i.contact,
-            supported_nips: Some(vec![1, 2, 9, 11, 12, 15, 16, 22, 26]),
+            supported_nips: Some(vec![1, 2, 9, 11, 12, 15, 16, 20, 22, 26]),
            software: Some("https://git.sr.ht/~gheartsfield/nostr-rs-relay".to_owned()),
            version: CARGO_PKG_VERSION.map(|x| x.to_owned()),
        }
@@ -1,13 +1,15 @@
-use crate::error;
-
 pub enum EventResultStatus {
    Saved,
    Duplicate,
-    Error(String),
+    Invalid,
+    Blocked,
+    RateLimited,
+    Error,
 }

 pub struct EventResult {
    pub id: String,
+    pub msg: String,
    pub status: EventResultStatus,
 }

@@ -16,33 +18,69 @@ pub enum Notice {
    EventResult(EventResult),
 }

-impl Notice {
-    pub fn err(err: error::Error, id: String) -> Notice {
-        Notice::err_msg(format!("{}", err), id)
+impl EventResultStatus {
+    pub fn to_bool(&self) -> bool {
+        match self {
+            Self::Saved => true,
+            Self::Duplicate => true,
+            Self::Invalid => false,
+            Self::Blocked => false,
+            Self::RateLimited => false,
+            Self::Error => false,
        }
+    }
+
+    pub fn prefix(&self) -> &'static str {
+        match self {
+            Self::Saved => "saved",
+            Self::Duplicate => "duplicate",
+            Self::Invalid => "invalid",
+            Self::Blocked => "blocked",
+            Self::RateLimited => "rate-limited",
+            Self::Error => "error",
+        }
+    }
+}
+
+impl Notice {
+    //pub fn err(err: error::Error, id: String) -> Notice {
+    //    Notice::err_msg(format!("{}", err), id)
+    //}

    pub fn message(msg: String) -> Notice {
        Notice::Message(msg)
    }

-    pub fn saved(id: String) -> Notice {
-        Notice::EventResult(EventResult {
-            id,
-            status: EventResultStatus::Saved,
-        })
+    fn prefixed(id: String, msg: &str, status: EventResultStatus) -> Notice {
+        let msg = format!("{}: {}", status.prefix(), msg);
+        Notice::EventResult(EventResult { id, msg, status })
+    }
+
+    pub fn invalid(id: String, msg: &str) -> Notice {
+        Notice::prefixed(id, msg, EventResultStatus::Invalid)
+    }
+
+    pub fn blocked(id: String, msg: &str) -> Notice {
+        Notice::prefixed(id, msg, EventResultStatus::Blocked)
+    }
+
+    pub fn rate_limited(id: String, msg: &str) -> Notice {
+        Notice::prefixed(id, msg, EventResultStatus::RateLimited)
    }

    pub fn duplicate(id: String) -> Notice {
-        Notice::EventResult(EventResult {
-            id,
-            status: EventResultStatus::Duplicate,
-        })
+        Notice::prefixed(id, "", EventResultStatus::Duplicate)
    }

-    pub fn err_msg(msg: String, id: String) -> Notice {
+    pub fn error(id: String, msg: &str) -> Notice {
+        Notice::prefixed(id, msg, EventResultStatus::Error)
+    }
+
+    pub fn saved(id: String) -> Notice {
        Notice::EventResult(EventResult {
            id,
-            status: EventResultStatus::Error(msg),
+            msg: "".into(),
+            status: EventResultStatus::Saved,
        })
    }
 }
@@ -10,7 +10,7 @@ use crate::event::Event;
 use crate::event::EventCmd;
 use crate::info::RelayInfo;
 use crate::nip05;
-use crate::notice::{EventResultStatus, Notice};
+use crate::notice::Notice;
 use crate::subscription::Subscription;
 use futures::SinkExt;
 use futures::StreamExt;
@@ -409,11 +409,7 @@ fn convert_to_msg(msg: String, max_bytes: Option<usize>) -> Result<NostrMessage>
 fn make_notice_message(notice: Notice) -> Message {
    let json = match notice {
        Notice::Message(ref msg) => json!(["NOTICE", msg]),
-        Notice::EventResult(ref res) => match &res.status {
-            EventResultStatus::Saved => json!(["OK", res.id, "true"]),
-            EventResultStatus::Duplicate => json!(["OK", res.id, "true", "duplicate"]),
-            EventResultStatus::Error(msg) => json!(["OK", res.id, "false", msg]),
-        },
+        Notice::EventResult(ref res) => json!(["OK", res.id, res.status.to_bool(), res.msg]),
    };

    Message::text(json.to_string())
@@ -576,6 +572,7 @@ async fn nostr_server(
                    Ok(NostrMessage::EventMsg(ec)) => {
                        // An EventCmd needs to be validated to be converted into an Event
                        // handle each type of message
+                        let evid = ec.event_id().to_owned();
                        let parsed : Result<Event> = Result::<Event>::from(ec);
                        match parsed {
                            Ok(e) => {
@@ -590,15 +587,15 @@ async fn nostr_server(
                } else {
                    info!("client: {} sent a far future-dated event", cid);
                    if let Some(fut_sec) = settings.options.reject_future_seconds {
-                        let msg = format!("The event created_at field is out of the acceptable range (+{}sec) for this relay and was not stored.",fut_sec);
-                        let notice = Notice::err_msg(msg, e.id);
+                        let msg = format!("The event created_at field is out of the acceptable range (+{}sec) for this relay.",fut_sec);
+                        let notice = Notice::invalid(e.id, &msg);
                        ws_stream.send(make_notice_message(notice)).await.ok();
                    }
                }
                            },
-                            Err(_) => {
+                            Err(e) => {
                                info!("client: {} sent an invalid event", cid);
-                                ws_stream.send(make_notice_message(Notice::message("event was invalid".into()))).await.ok();
+                                ws_stream.send(make_notice_message(Notice::invalid(evid, &format!("{}", e)))).await.ok();
                            }
                        }
                    },
@@ -620,7 +617,7 @@ async fn nostr_server(
                            },
                            Err(e) => {
                                info!("Subscription error: {}", e);
-                                ws_stream.send(make_notice_message(Notice::err(e, s.id))).await.ok();
+                                ws_stream.send(make_notice_message(Notice::message(format!("Subscription error: {}", e)))).await.ok();
                            }
                        }
                    },
Author	SHA1	Message	Date
Greg Heartsfield	06078648c8	build: bump version to 0.7.2	2022-11-19 07:55:52 -06:00
Greg Heartsfield	cc0fcc5d66	docs: add Cargo package metadata	2022-11-19 07:32:17 -06:00
Greg Heartsfield	dfb2096653	improvement: build auditable binary in docker	2022-11-19 07:11:39 -06:00
Greg Heartsfield	486508d192	improvement: upgrade multiple dependencies Updating crates.io index Updating cc v1.0.74 -> v1.0.76 Updating chrono v0.4.22 -> v0.4.23 Updating cxx v1.0.80 -> v1.0.82 Updating cxx-build v1.0.80 -> v1.0.82 Updating cxxbridge-flags v1.0.80 -> v1.0.82 Updating cxxbridge-macro v1.0.80 -> v1.0.82 Updating digest v0.10.5 -> v0.10.6 Updating hyper v0.14.22 -> v0.14.23 Updating indexmap v1.9.1 -> v1.9.2 Updating regex v1.6.0 -> v1.7.0 Updating regex-syntax v0.6.27 -> v0.6.28 Updating serde_json v1.0.87 -> v1.0.88 Updating tokio v1.21.2 -> v1.22.0 Updating uuid v1.2.1 -> v1.2.2	2022-11-19 06:52:06 -06:00
Greg Heartsfield	84b43c144b	improvement: use locked cargo packages to build container images	2022-11-19 06:29:13 -06:00
Greg Heartsfield	110500bb46	feat(NIP-20): advertise support for NIP-20 in relay info/readme	2022-11-12 09:22:43 -06:00
Greg Heartsfield	83f6b11de7	refactor: clippy fix	2022-11-12 09:22:24 -06:00
William Casarin	6d1244434b	feat(NIP-20): improve invalid event error messages Instead of returning a NOTICE for invalid events, return a `OK false` command result with a reason as to why the event is invalid.	2022-11-12 09:13:22 -06:00
William Casarin	5a91419d34	feat(NIP-20): send command results to clients When submitting events to relays, clients currently have no way to know if an event was successfully committed to the database. This NIP introduces the concept of command results which are like NOTICE's except provide more information about if an event was accepted or rejected. A command result is a JSON object with the following structure that is returned when an event is successfully saved to the database or rejected: ["OK", <event_id>, <true\|false>, <message>] nip20: https://github.com/nostr-protocol/nips/pull/62	2022-11-12 09:12:35 -06:00