//! Code to handle the inner document of an onion service descriptor.

use std::num::NonZeroU8;

use std::time::SystemTime;

use super::{IntroAuthType, IntroPointDesc};

use crate::batching_split_before::IteratorExt as _;

use crate::doc::hsdesc::pow::PowParamSet;

use crate::parse::tokenize::{ItemResult, NetDocReader};

use crate::parse::{keyword::Keyword, parser::SectionRules};

use crate::types::misc::{B64, UnvalidatedEdCert};

use crate::{NetdocErrorKind as EK, Result};

use itertools::Itertools as _;

use smallvec::SmallVec;

use std::sync::LazyLock;

use tor_checkable::TimeBound;

use tor_checkable::signed::SignatureGated;

use tor_checkable::timed::TimeRangeBound;

use tor_hscrypto::NUM_INTRO_POINT_MAX;

use tor_hscrypto::pk::{HsIntroPtSessionIdKey, HsSvcNtorKey};

use tor_llcrypto::pk::ed25519::Ed25519Identity;

use tor_llcrypto::pk::{ValidatableSignature, curve25519, ed25519};

use tor_protover::Protocols;

/// The contents of the inner document of an onion service descriptor.

#[derive(Debug, Clone)]

pub struct HsDescInner {

    /// The authentication types that this onion service accepts when

    /// connecting.

    //

    // TODO: This should probably be a bitfield or enum-set of something.

    // Once we know whether the "password" authentication type really exists,

    // let's change to a better representation here.

    pub(super) intro_auth_types: Option<SmallVec<[IntroAuthType; 2]>>,

    /// Is this onion service a "single onion service?"

    ///

    /// (A "single onion service" is one that is not attempting to anonymize

    /// itself.)

    pub(super) single_onion_service: bool,

    /// A list of advertised introduction points and their contact info.

    //

    // Always has >= 1 and <= NUM_INTRO_POINT_MAX entries

    pub(super) intro_points: Vec<IntroPointDesc>,

    /// A list of offered proof-of-work parameters, at most one per type.

    pub(super) pow_params: PowParamSet,

    /// A specified sendme increment and sub protocol capability list, if they were provided.

    ///

    /// Note that for historical reasons the protocol capabilities here are treated separately

    /// from those in `protos`.

    pub(super) flow_control: Option<(Protocols, NonZeroU8)>,

    /// A list of subprotocol capabilities advertised by the onion service.

    ///

    /// Note that for historical reasons.

    pub(super) protos: Protocols,

}

decl_keyword! {

    pub(crate) HsInnerKwd {

        "create2-formats" => CREATE2_FORMATS,

        "intro-auth-required" => INTRO_AUTH_REQUIRED,

        "single-onion-service" => SINGLE_ONION_SERVICE,

        "introduction-point" => INTRODUCTION_POINT,

        "onion-key" => ONION_KEY,

        "auth-key" => AUTH_KEY,

        "enc-key" => ENC_KEY,

        "enc-key-cert" => ENC_KEY_CERT,

        "legacy-key" => LEGACY_KEY,

        "legacy-key-cert" => LEGACY_KEY_CERT,

        "pow-params" => POW_PARAMS,

        "flow-control" => FLOW_CONTROL,

        "proto" => PROTO,

    }

}

/// Rules about how keywords appear in the header part of an onion service

/// descriptor.

    use HsInnerKwd::*;

/// Rules about how keywords appear in each introduction-point section of an

/// onion service descriptor.

    use HsInnerKwd::*;

    // Note: we're labeling ONION_KEY and ENC_KEY as "may_repeat", since even

    // though rend-spec labels them as "exactly once", they are allowed to

    // appear more than once so long as they appear only once _with an "ntor"_

    // key.  torspec!110 tries to document this issue.

    // NOTE: We never look at the LEGACY_KEY* fields.  This does provide a

    // distinguisher for Arti implementations and C tor implementations, but

    // that's outside of Arti's threat model.

    //

    // (In fact, there's an easier distinguisher, since we enforce UTF-8 in

    // these documents, and C tor does not.)

/// Helper type returned when we parse an HsDescInner.

pub(crate) type UncheckedHsDescInner = TimeRangeBound<SignatureGated<HsDescInner>>;

/// Information about one of the certificates inside an HsDescInner.

///

/// This is a teporary structure that we use when parsing.

struct InnerCertData {

    /// The identity of the key that purportedly signs this certificate.

    signing_key: Ed25519Identity,

    /// The key that is being signed.

    subject_key: ed25519::PublicKey,

    /// A detached signature object that we must validate before we can conclude

    /// that the certificate is valid.

    signature: Box<dyn ValidatableSignature>,

    /// The time when the certificate expires.

    expiry: SystemTime,

}

/// Decode a certificate from `tok`, and check that its tag and type are

/// expected, that it contains a signing key,  and that both signing and subject

/// keys are Ed25519.

///

/// On success, return an InnerCertData.

    // These certs have to include a signing key.

    // Peel off the signature.

    // Peel off the expiration

impl HsDescInner {

    /// Attempt to parse the inner document of an onion service descriptor from a

    /// provided string.

    ///

    /// On success, return the signing key that was used for every certificate in the

    /// inner document, and the inner document itself.

    /// Attempt to parse the inner document of an onion service descriptor from a

    /// provided reader.

    ///

    /// On success, return the signing key that was used for every certificate in the

    /// inner document, and the inner document itself.

    //

    // TODO: replace Itertools::exactly_one() with a stdlib equivalent when there is one.

    //

    // See issue #48919 <https://github.com/rust-lang/rust/issues/48919>

    #[allow(unstable_name_collisions)]

        use HsInnerKwd::*;

        // Split up the input at INTRODUCTION_POINT items

        // Parse the header.

        // Make sure that the "ntor" handshake is supported in the list of

        // `HTYPE`s (handshake types) in `create2-formats`.

        {

            // If we ever want to support a different HTYPE, we'll need to

            // store at least the intersection between "their" and "our" supported

            // HTYPEs.  For now we only support one, so either this set is empty

            // and failing now is fine, or `ntor` (2) is supported, so fine.

        }

        // Check whether any kind of introduction-point authentication is

        // specified in an `intro-auth-required` line.

                #[allow(clippy::single_match)]

                }

            }

            // .. but if no types are recognized, we can't connect.

        } else {

        };

        // Recognize `single-onion-service` if it's there.

        // Recognize `pow-params`, parsing each line and rejecting duplicate types

        } else {

        };

        } else {

        };

        // Now we parse the introduction points.  Each of these will be a

        // section starting with `introduction-point`, ending right before the

        // next `introduction-point` (or before the end of the document.)

            // Parse link-specifiers

            };

            // Parse the ntor "onion-key" (`KP_ntor`) of the introduction point.

            };

            // Extract the auth_key (`KP_hs_ipt_sid`) from the (unchecked)

            // "auth-key" certificate.

                // Note that this certificate does not actually serve any

                // function _as_ a certificate; it was meant to cross-certify

                // the descriptor signing key (`KP_hs_desc_sign`) using the

                // authentication key (`KP_hs_ipt_sid`).  But the C tor

                // implementation got it backwards.

                //

                // We have to parse this certificate to extract

                // `KP_hs_ipt_sid`, but we don't actually need to validate it:

                // it appears inside the inner document, which is already signed

                // with `KP_hs_desc_sign`.  Nonetheless, we validate it anyway,

                // since that's what C tor does.

                //

                // See documentation for `CertType::HS_IP_V_SIGNING for more

                // info`.

                let InnerCertData {

                    tor_cert::CertType::HS_IP_V_SIGNING,

            };

            // Extract the key `KP_hss_ntor` that we'll use for our

            // handshake with the onion service itself.  This comes from the

            // "enc-key" item.

            };

            // Check that the key in the "enc-key-cert" item matches the

            // `KP_hss_ntor` we just extracted.

            {

                // NOTE: As above, this certificate is backwards, and hence

                // useless.  Still, we validate it because that is what C tor does.

                let InnerCertData {

                    tor_cert::CertType::HS_IP_CC_SIGNING,

                // Yes, the sign bit is always zero here. This would have a 50%

                // chance of making  the key unusable for verification. But since

                // the certificate is backwards (see above) we don't actually have

                // to check any signatures with it.

                    );

                // Make sure signing key is as expected.

            };

            // TODO SPEC: State who enforces NUM_INTRO_POINT_MAX and how (hsdirs, clients?)

            //

            // Simply discard extraneous IPTs.  The MAX value is hardcoded now, but a future

            // protocol evolution might increase it and we should probably still work then.

            //

            // If the spec intended that hsdirs ought to validate this and reject descriptors

            // with more than MAX (when they can), then this code is wrong because it would

            // prevent any caller (eg future hsdir code in arti relay) from seeing the violation.

        }

        // TODO SPEC: Might a HS publish descriptor with no IPTs to declare itself down?

        // If it might, then we should:

        //   - accept such descriptors here

        //   - check for this situation explicitly in tor-hsclient connect.rs intro_rend_connect

        //   - bail with a new `ConnError` (with ErrorKind OnionServiceNotRunning)

        // with the consequence that once we obtain such a descriptor,

        // we'll be satisfied with it and consider the HS down until the descriptor expires.

        };

}

#[cfg(test)]

mod test {

    // @@ begin test lint list maintained by maint/add_warning @@

    #![allow(clippy::bool_assert_comparison)]

    #![allow(clippy::clone_on_copy)]

    #![allow(clippy::dbg_macro)]

    #![allow(clippy::mixed_attributes_style)]

    #![allow(clippy::print_stderr)]

    #![allow(clippy::print_stdout)]

    #![allow(clippy::single_char_pattern)]

    #![allow(clippy::unwrap_used)]

    #![allow(clippy::unchecked_time_subtraction)]

    #![allow(clippy::useless_vec)]

    #![allow(clippy::needless_pass_by_value)]

    #![allow(clippy::string_slice)] // See arti#2571

    //! <!-- @@ end test lint list maintained by maint/add_warning @@ -->

    use std::{iter, time::Duration};

    use hex_literal::hex;

    use itertools::chain;

    use tor_checkable::{SelfSigned, TimeBound};

    use super::*;

    use crate::doc::hsdesc::{

        middle::HsDescMiddle,

        outer::HsDescOuter,

        pow::PowParams,

        test_data::{TEST_DATA, TEST_SUBCREDENTIAL},

    };

    /// Test one particular canned 'inner' document, checking

    /// edge cases for zero intro points and too many intro points

    #[test]

    fn inner_text() {

        // This is the inner document from hsdesc1.txt aka TEST_DATA

        const TEST_DATA_INNER: &str = include_str!("../../../testdata/hsdesc-inner.txt");

        use crate::NetdocErrorKind as NEK;

        let _desc = HsDescInner::parse(TEST_DATA_INNER).unwrap();

        let none = format!(

            "{}\n",

            TEST_DATA_INNER

                .split_once("\nintroduction-point")

                .unwrap()

                .0,

        );

        let err = HsDescInner::parse(&none).map(|_| &none).unwrap_err();

        assert_eq!(err.kind, NEK::MissingEntry);

        let ipt = format!(

            "introduction-point{}",

            TEST_DATA_INNER

                .rsplit_once("\nintroduction-point")

                .unwrap()

                .1,

        );

        for n in NUM_INTRO_POINT_MAX..NUM_INTRO_POINT_MAX + 2 {

            let many =

                chain!(iter::once(&*none), std::iter::repeat_n(&*ipt, n),).collect::<String>();

            let desc = HsDescInner::parse(&many).unwrap();

            let desc = desc

                .1

                .dangerously_into_parts()

                .0

                .dangerously_assume_wellsigned();

            assert_eq!(desc.intro_points.len(), NUM_INTRO_POINT_MAX);

        }

    }

    /// Test parseability of an inner document generated by C tor with PoW v1

    #[test]

    #[cfg(feature = "hs-pow-full")]

    fn inner_c_pow_v1() {

        const TEST_DATA_INNER: &str = include_str!("../../../testdata/hsdesc-inner-pow-v1.txt");

        let desc = HsDescInner::parse(TEST_DATA_INNER).unwrap();

        let pow_params = desc

            .1

            .dangerously_into_parts()

            .0

            .dangerously_assume_wellsigned()

            .pow_params;

        assert_eq!(pow_params.slice().len(), 1);

        match &pow_params.slice()[0] {

            PowParams::V1(v1) => {

                let expected_effort: tor_hscrypto::pow::v1::Effort = 614.into();

                let expected_seed: tor_hscrypto::pow::v1::Seed =

                    hex!("144e901df0841833a6e8592190849b4412f307d1565f2f137b2a5bc21a31092a").into();

                let expected_expiry = Some(SystemTime::UNIX_EPOCH + Duration::new(1712812537, 0));

                assert_eq!(v1.suggested_effort(), expected_effort);

                assert_eq!(

                    v1.seed().to_owned().dangerously_assume_timely(),

                    expected_seed

                );

                assert_eq!(v1.seed().bounds_start_end().1, expected_expiry);

            }

            #[allow(unreachable_patterns)]

            _ => unreachable!(),

        }

    }

    /// Ensure the same valid v1 pow document parses with the addition of unknown schemes

    #[test]

    fn inner_c_pow_v1_with_unknown() {

        const TEMPLATE: &str = include_str!("../../../testdata/hsdesc-inner-pow-v1.txt");

        let parts = TEMPLATE.rsplit_once("\npow-params").unwrap();

        let test_data_inner = format!("{}\npow-params x-example\npow-params{}", parts.0, parts.1);

        let desc = HsDescInner::parse(&test_data_inner).unwrap();

        let pow_params = desc

            .1

            .dangerously_into_parts()

            .0

            .dangerously_assume_wellsigned()

            .pow_params;

        assert_eq!(pow_params.slice().len(), 1);

    }

    /// Incorrect reduced document with a pow-params line that has no scheme parameter

    #[test]

    fn inner_pow_empty() {

        const TEST_DATA_INNER: &str = include_str!("../../../testdata/hsdesc-inner-pow-empty.txt");

        let err = HsDescInner::parse(TEST_DATA_INNER).map(|_| ()).unwrap_err();

        assert_eq!(err.kind, crate::NetdocErrorKind::TooFewArguments);

    }

    /// Incorrect document with duplicated pow-params lines of the same known type

    #[test]

    fn inner_pow_duplicate() {

        // Modify the canned v1 pow example from c tor, by duplicating the entire pow-params line

        const TEMPLATE: &str = include_str!("../../../testdata/hsdesc-inner-pow-v1.txt");

        let first_split = TEMPLATE.rsplit_once("\npow-params").unwrap();

        let second_split = first_split.1.split_once("\n").unwrap();

        let test_data_inner = format!(

            "{}\npow-params{}\npow-params{}\n{}",

            first_split.0, second_split.0, second_split.0, second_split.1

        );

        let err = HsDescInner::parse(&test_data_inner)

            .map(|_| ())

            .unwrap_err();

        assert_eq!(err.kind, crate::NetdocErrorKind::DuplicateToken);

    }

    /// Incorrect document with an unexpected object encoded after the pow v1 scheme's pow-params

    #[test]

    #[cfg(feature = "hs-pow-full")]

    fn inner_pow_v1_object() {

        // Modify the canned v1 pow example

        const TEMPLATE: &str = include_str!("../../../testdata/hsdesc-inner-pow-v1.txt");

        let first_split = TEMPLATE.rsplit_once("\npow-params").unwrap();

        let second_split = first_split.1.split_once("\n").unwrap();

        let test_data_inner = format!(

            "{}\npow-params{}\n-----BEGIN THING-----\n-----END THING-----\n{}",

            first_split.0, second_split.0, second_split.1

        );

        let err = HsDescInner::parse(&test_data_inner)

            .map(|_| ())

            .unwrap_err();

        assert_eq!(err.kind, crate::NetdocErrorKind::UnexpectedObject);

    }

    /// Document including an unrecognized pow-params line, ignored without error and not

    /// represented in the output at all.

    ///

    /// Also tests that unrecognized schemes are not subject to a restriction against

    /// duplicate appearances. (The spec allows that implementations do not need to

    /// implement this prohibition for arbitrary scheme strings)

    ///

    /// TODO: We may want PowParamSet to provide a representation for arbitrary unknown PoW

    ///       schemes, to the extent that this information may be useful for error reporting

    ///       purposes after an onion service rendezvous fails.

    #[test]

    fn inner_pow_unrecognized() {

        // Use the reduced document from inner_pow_empty() as a template

        const TEMPLATE: &str = include_str!("../../../testdata/hsdesc-inner-pow-empty.txt");

        let parts = TEMPLATE.rsplit_once("\npow-params").unwrap();

        let test_data_inner = format!(

            "{}\npow-params x-example\npow-params x-example{}",

            parts.0, parts.1

        );

        let desc = HsDescInner::parse(&test_data_inner).unwrap();

        let pow_params = desc

            .1

            .dangerously_into_parts()

            .0

            .dangerously_assume_wellsigned()

            .pow_params;

        assert_eq!(pow_params.slice().len(), 0);

    }

    /// Document with an unrecognized pow-params line including an object

    #[test]

    fn inner_pow_unrecognized_object() {

        // Use the reduced document from inner_pow_empty() as a template

        const TEMPLATE: &str = include_str!("../../../testdata/hsdesc-inner-pow-empty.txt");

        let parts = TEMPLATE.rsplit_once("\npow-params").unwrap();

        let test_data_inner = format!(

            "{}\npow-params x-something-else with args\n-----BEGIN THING-----\n-----END THING-----{}",

            parts.0, parts.1

        );

        let desc = HsDescInner::parse(&test_data_inner).unwrap();

        let pow_params = desc

            .1

            .dangerously_into_parts()

            .0

            .dangerously_assume_wellsigned()

            .pow_params;

        assert_eq!(pow_params.slice().len(), 0);

    }

    #[test]

    fn parse_good() -> Result<()> {

        let desc = HsDescOuter::parse(TEST_DATA)?

            .dangerously_assume_wellsigned()

            .dangerously_assume_timely();

        let subcred = TEST_SUBCREDENTIAL.into();

        let body = desc.decrypt_body(&subcred).unwrap();

        let body = std::str::from_utf8(&body[..]).unwrap();

        let middle = HsDescMiddle::parse(body)?;

        let inner_body = middle

            .decrypt_inner(&desc.blinded_id(), desc.revision_counter(), &subcred, None)

            .unwrap();

        let inner_body = std::str::from_utf8(&inner_body).unwrap();

        let (ed_id, inner) = HsDescInner::parse(inner_body)?;

        let inner = inner

            .if_valid_at(&humantime::parse_rfc3339("2023-01-23T15:00:00Z").unwrap())

            .unwrap()

            .check_signature()

            .unwrap();

        assert_eq!(ed_id.as_ref(), Some(desc.desc_sign_key_id()));

        assert!(inner.intro_auth_types.is_none());

        assert_eq!(inner.single_onion_service, false);

        assert_eq!(inner.intro_points.len(), 3);

        let ipt0 = &inner.intro_points[0];

        assert_eq!(

            ipt0.ipt_ntor_key().as_bytes(),

            &hex!("553BF9F9E1979D6F5D5D7D20BB3FE7272E32E22B6E86E35C76A7CA8A377E402F")

        );

        assert_ne!(ipt0.link_specifiers, inner.intro_points[1].link_specifiers);

        Ok(())

    }

}