Skip to main content

GitCredentialHelper

Struct GitCredentialHelper 

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

Shells out to the git binary’s credential subsystem.

git_program defaults to "git". Override for tests via Self::with_program — point at a fake git that records its input or scripts a response.

protect_protocol mirrors credential.protectProtocol (default true). When set, every value written to git credential stdin is rejected if it contains a carriage return — preventing newline-based protocol smuggling. Newlines and null bytes are rejected unconditionally regardless of this flag.

Implementations§

Source§

impl GitCredentialHelper

Source

pub fn new() -> Self

Build a helper that shells out to the system git binary.

Source

pub fn with_program(git_program: impl Into<String>) -> Self

Build the helper around a custom git-compatible binary.

Used by the integration tests, which point at a shell script that fakes the protocol.

Source

pub fn with_protect_protocol(self, protect: bool) -> Self

Toggle credential.protectProtocol for this helper.

Default is true. Pass false only when the user has explicitly opted out; carriage returns in URLs are otherwise a known smuggling vector.

Trait Implementations§

Source§

impl Clone for GitCredentialHelper

Source§

fn clone(&self) -> GitCredentialHelper

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GitCredentialHelper

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GitCredentialHelper

Source§

fn default() -> Self

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

impl Helper for GitCredentialHelper

Source§

fn fill(&self, query: &Query) -> Result<Option<Credentials>, HelperError>

Try to fetch credentials for query. Read more
Source§

fn approve(&self, query: &Query, creds: &Credentials) -> Result<(), HelperError>

Tell the helper that creds worked for query. Read more
Source§

fn reject(&self, query: &Query, creds: &Credentials) -> Result<(), HelperError>

Tell the helper that creds did not work for query. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.