Skip to main content

PromptInjectionHook

Struct PromptInjectionHook 

Source
pub struct PromptInjectionHook { /* private fields */ }
Expand description

Detects and sanitizes prompt injections in tool output.

Scans tool results in the on_after_tool_call phase; when any pattern in DEFAULT_INJECTION_PATTERNS (or a custom pattern) matches, replaces the whole result with a safe placeholder so malicious instructions never reach the next plan() prompt (blocking cross-turn pollution).

§Example

use lc_agents::hooks::PromptInjectionHook;

let executor = AgentExecutor::new(agent, tools)
    .hook(PromptInjectionHook::new());

Implementations§

Source§

impl PromptInjectionHook

Source

pub fn new() -> Self

Creates the hook with the default injection patterns.

Source

pub fn with_patterns(self, patterns: Vec<String>) -> Self

Replaces the default patterns with a custom list.

Source

pub fn with_marker(self, marker: impl Into<String>) -> Self

Custom replacement placeholder; when it contains {}, it is filled with the matched pattern text.

Source

pub fn detect(&self, text: &str) -> Option<&str>

Detects whether the text contains an injection pattern; returns the matched pattern (None if no match).

Source

pub fn detected_count(&self) -> usize

Cumulative number of injections detected.

Trait Implementations§

Source§

impl AgentHook for PromptInjectionHook

Source§

fn on_after_tool_call( &self, ctx: &mut ToolResultContext, ) -> Result<(), HookError>

Called after a tool call. Can modify the result.
Source§

fn on_before_completion(&self, _ctx: &mut CompletionContext) -> CompletionAction

Called before an LLM completion. Can modify messages or reject the call.
Source§

fn on_after_completion( &self, _ctx: &mut CompletionResult, ) -> Result<(), HookError>

Called after an LLM completion. Can modify the response.
Source§

fn on_before_tool_call(&self, _ctx: &mut ToolCallContext) -> ToolCallAction

Called before a tool call. Can approve, reject, modify, or skip.
Source§

fn on_stream_chunk(&self, chunk: &str) -> StreamAction

Called for each streaming token. Can filter, replace, or forward.
Source§

fn on_agent_start(&self, _input: &str) -> Result<(), HookError>

Called when the agent starts execution.
Source§

fn on_agent_end(&self, _output: &str) -> Result<(), HookError>

Called when the agent finishes execution.
Source§

fn on_error(&self, _error: &HookError) -> ErrorAction

Called when an error occurs. Can retry, ignore, or propagate.
Source§

impl Default for PromptInjectionHook

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more