Struct ExternallyManagedCredential 

pub struct ExternallyManagedCredential {
    pub command: PathBuf,
    pub args: Vec<String>,
    pub timeout_seconds: u64,
}

A credential whose access tokens come from running an external program, rather than from tokens stored in secrets.toml.

This is how you integrate QCS clients with a credential helper in e.g. hosted environments. Valid tokens are cached in-process so the subcommand is only called when a new token is needed.

With this method, tokens are never written back to secrets.toml.

Schema

[credentials.coder.externally_managed]
# Required.
command = "/usr/bin/coder"
# Optional. Passed to the program verbatim; no shell is involved, so no quoting or
# escaping is applied or required.
args = ["external-auth", "access-token", "qcs"]
# Optional, defaults to 30. How long the program may run before it is killed.
timeout_seconds = 30

All super::settings::Profiles still reference an auth_server, although this credential method does not use the auth server when fetching credential.

Security

This turns secrets.toml into a file that causes code to run: anyone who can write to it, or to the program it names, can run arbitrary code as you. The program runs with this process’s environment, so it sees the same PATH and variables the client does.

The usual precautions apply if that matters for your environment: keep secrets.toml writable only by your own user, and give command an absolute path so it can’t be resolved through an attacker-controlled PATH.

The subcommand’s stderr is included in error messages, so avoid emitting sensitive values there.

Fields

command: PathBuf

Path to the program that produces an access token on stdout.

args: Vec<String>

Arguments passed to the program verbatim, without shell interpretation.

timeout_seconds: u64

How long the program may run before it is killed. Defaults to 30 seconds.

Implementations

impl ExternallyManagedCredential

pub async fn request_access_token( &self, ) -> Result<SecretAccessToken, ExternalCommandError>

Run the program and return the access token it prints to stdout.

Errors

See ExternalCommandError.

Trait Implementations

impl Clone for ExternallyManagedCredential

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternallyManagedCredential

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExternallyManagedCredential

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ExternallyManagedCredential

impl From<ExternallyManagedCredential> for ExternallyManaged

fn from(credential: ExternallyManagedCredential) -> Self

Converts to this type from the input type.

impl PartialEq for ExternallyManagedCredential

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ExternallyManagedCredential

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ExternallyManagedCredential