Struct tor_hsservice::ipt_mgr::Ipt

struct Ipt {
    lid: IptLocalId,
    establisher: Box<dyn Any + Send + Sync + 'static>,
    k_sid: Arc<HsIntroPtSessionIdKeypair>,
    k_hss_ntor: Arc<HsSvcNtorKeypair>,
    status_last: TrackedStatus,
    last_descriptor_expiry_including_slop: Option<Instant>,
    is_current: Option<IsCurrent>,
}

One introduction point, representation in memory

Fields

lid: IptLocalId

Local persistent identifier

establisher: Box<dyn Any + Send + Sync + 'static>

Handle for the establisher; we keep this here just for its Drop action

k_sid: Arc<HsIntroPtSessionIdKeypair>

KS_hs_ipt_sid, KP_hs_ipt_sid

This is an Arc because:

• The manager needs a copy so that it can save it to disk.
• The establisher needs a copy to actually use.
• The underlying secret key type is not Clone.

k_hss_ntor: Arc<HsSvcNtorKeypair>

KS_hss_ntor, KP_hss_ntor

status_last: TrackedStatus

Last information about how it’s doing including timing info

last_descriptor_expiry_including_slop: Option<Instant>

Until when ought we to try to maintain it

For introduction points we are publishing, this is a copy of the value set by the publisher in the IptSet we share with the publisher,

(None means the IPT has not been advertised at all yet.)

We must duplicate the information because:

• We can’t have it just live in the shared IptSet because we need to retain it for no-longer-being published IPTs.

• We can’t have it just live here because the publisher needs to update it.

(An alternative would be to more seriously entangle the manager and publisher.)

is_current: Option<IsCurrent>

Is this IPT current - should we include it in descriptors ?

None might mean:

• WantsToRetire
• We have >N IPTs and we have been using this IPT so long we want to rotate it out (the IptRelay has reached its planned_retirement time)
• The IPT has wrong parameters of some kind, and needs to be replaced (Eg, we set it up with the wrong DOS_PARAMS extension)

Implementations

impl Ipt

fn start_establisher<R: Runtime, M: Mockable<R>>( imm: &Immutable<R>, new_configs: &Receiver<Arc<OnionServiceConfig>>, mockable: &mut M, relay: &RelayIds, lid: IptLocalId, is_current: Option<IsCurrent>, expect_existing_keys: Option<IptExpectExistingKeys>, _: PromiseLastDescriptorExpiryNoneIsGood ) -> Result<Ipt, CreateIptError>

Start a new IPT establisher, and create and return an Ipt

fn is_good(&self) -> bool

Returns true if this IPT has status Good (and should perhaps be published)

fn error(&self) -> Option<&IptError>

Returns the error, if any, we are currently encountering at this IPT.

fn for_publish(&self, details: &GoodIptDetails) -> Result<IntroPointDesc, Bug>

Construct the information needed by the publisher for this intro point

Trait Implementations

impl Debug for Ipt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.