1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
//! Various permissions to define what can be done when operating a [`Repository`][crate::Repository].
use gix_sec::Trust;
use crate::open::Permissions;
/// Configure from which sources git configuration may be loaded.
///
/// Note that configuration from inside of the repository is always loaded as it's definitely required for correctness.
#[derive(Copy, Clone, Ord, PartialOrd, PartialEq, Eq, Debug, Hash)]
pub struct Config {
/// The git binary may come with configuration as part of its configuration, and if this is true (default false)
/// we will load the configuration of the git binary, if present and not a duplicate of the ones below.
///
/// It's disabled by default as it may involve executing the git binary once per execution of the application.
pub git_binary: bool,
/// Whether to use the system configuration.
/// This is defined as `$(prefix)/etc/gitconfig` on unix.
pub system: bool,
/// Whether to use the git application configuration.
///
/// A platform defined location for where a user's git application configuration should be located.
/// If `$XDG_CONFIG_HOME` is not set or empty, `$HOME/.config/git/config` will be used
/// on unix.
pub git: bool,
/// Whether to use the user configuration.
/// This is usually `~/.gitconfig` on unix.
pub user: bool,
/// Whether to use the configuration from environment variables.
pub env: bool,
/// Whether to follow include files are encountered in loaded configuration,
/// via `include` and `includeIf` sections.
pub includes: bool,
}
impl Config {
/// Allow everything which usually relates to a fully trusted environment
pub fn all() -> Self {
Config {
git_binary: false,
system: true,
git: true,
user: true,
env: true,
includes: true,
}
}
/// Load only configuration local to the git repository.
pub fn isolated() -> Self {
Config {
git_binary: false,
system: false,
git: false,
user: false,
env: false,
includes: false,
}
}
}
impl Default for Config {
fn default() -> Self {
Self::all()
}
}
/// Configure from which `gitattribute` files may be loaded.
///
/// Note that `.gitattribute` files from within the repository are always loaded.
#[derive(Copy, Clone, Ord, PartialOrd, PartialEq, Eq, Debug, Hash)]
pub struct Attributes {
/// The git binary may come with attribute configuration in its installation directory, and if this is true (default false)
/// we will load the configuration of the git binary.
///
/// It's disabled by default as it involves executing the git binary once per execution of the application.
pub git_binary: bool,
/// Whether to use the system configuration.
/// This is typically defined as `$(prefix)/etc/gitconfig`.
pub system: bool,
/// Whether to use the git application configuration.
///
/// A platform defined location for where a user's git application configuration should be located.
/// If `$XDG_CONFIG_HOME` is not set or empty, `$HOME/.config/git/attributes` will be used
/// on unix.
pub git: bool,
}
impl Attributes {
/// Allow everything which usually relates to a fully trusted environment
pub fn all() -> Self {
Attributes {
git_binary: false,
system: true,
git: true,
}
}
/// Allow loading attributes that are local to the git repository.
pub fn isolated() -> Self {
Attributes {
git_binary: false,
system: false,
git: false,
}
}
}
impl Default for Attributes {
fn default() -> Self {
Self::all()
}
}
/// Permissions related to the usage of environment variables
#[derive(Debug, Clone, Copy)]
pub struct Environment {
/// Control whether resources pointed to by `XDG_CONFIG_HOME` can be used when looking up common configuration values.
///
/// Note that [`gix_sec::Permission::Forbid`] will cause the operation to abort if a resource is set via the XDG config environment.
pub xdg_config_home: gix_sec::Permission,
/// Control the way resources pointed to by the home directory (similar to `xdg_config_home`) may be used.
pub home: gix_sec::Permission,
/// Control if environment variables to configure the HTTP transport, like `http_proxy` may be used.
///
/// Note that http-transport related environment variables prefixed with `GIT_` may also be included here
/// if they match this category like `GIT_HTTP_USER_AGENT`.
pub http_transport: gix_sec::Permission,
/// Control if the `EMAIL` environment variables may be read.
///
/// Note that identity related environment variables prefixed with `GIT_` may also be included here
/// if they match this category.
pub identity: gix_sec::Permission,
/// Control if environment variables related to the object database are handled. This includes features and performance
/// options alike.
pub objects: gix_sec::Permission,
/// Control if resources pointed to by `GIT_*` prefixed environment variables can be used, **but only** if they
/// are not contained in any other category. This is a catch-all section.
pub git_prefix: gix_sec::Permission,
/// Control if resources pointed to by `SSH_*` prefixed environment variables can be used (like `SSH_ASKPASS`)
pub ssh_prefix: gix_sec::Permission,
}
impl Environment {
/// Allow access to the entire environment.
pub fn all() -> Self {
let allow = gix_sec::Permission::Allow;
Environment {
xdg_config_home: allow,
home: allow,
git_prefix: allow,
ssh_prefix: allow,
http_transport: allow,
identity: allow,
objects: allow,
}
}
/// Don't allow loading any environment variables.
pub fn isolated() -> Self {
let deny = gix_sec::Permission::Deny;
Environment {
xdg_config_home: deny,
home: deny,
ssh_prefix: deny,
git_prefix: deny,
http_transport: deny,
identity: deny,
objects: deny,
}
}
}
impl Permissions {
/// Secure permissions are similar to `all()`
pub fn secure() -> Self {
Permissions {
env: Environment::all(),
config: Config::all(),
attributes: Attributes::all(),
}
}
/// Everything is allowed with this set of permissions, thus we read all configuration and do what git typically
/// does with owned repositories.
pub fn all() -> Self {
Permissions {
env: Environment::all(),
config: Config::all(),
attributes: Attributes::all(),
}
}
/// Don't read any but the local git configuration and deny reading any environment variables.
pub fn isolated() -> Self {
Permissions {
config: Config::isolated(),
attributes: Attributes::isolated(),
env: Environment::isolated(),
}
}
}
impl gix_sec::trust::DefaultForLevel for Permissions {
fn default_for_level(level: Trust) -> Self {
match level {
Trust::Full => Permissions::all(),
Trust::Reduced => Permissions::secure(),
}
}
}
impl Default for Permissions {
fn default() -> Self {
Permissions::secure()
}
}