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 217 218 219 220 221 222 223 224 225 226
#[derive(Debug, Args)]
struct CommonOpt {
/// Path to the server's configuration file. If it does not exist, it will be created.
#[clap(short, long = "config", env = "KANIDM_CONFIG")]
config_path: Option<PathBuf>,
/// Log format (still in very early development)
#[clap(short, long = "output", env = "KANIDM_OUTPUT", default_value = "text")]
output_mode: String,
}
#[derive(Debug, Args)]
struct BackupOpt {
#[clap(value_parser)]
/// Output path for the backup content.
path: PathBuf,
#[clap(flatten)]
commonopts: CommonOpt,
}
#[derive(Debug, Args)]
struct RestoreOpt {
#[clap(value_parser)]
/// Restore from this path. Should be created with "backup".
path: PathBuf,
#[clap(flatten)]
commonopts: CommonOpt,
}
#[derive(Debug, Subcommand)]
enum DomainSettingsCmds {
#[clap(name = "show")]
/// Show the current domain
Show {
#[clap(flatten)]
commonopts: CommonOpt,
},
#[clap(name = "rename")]
/// Change the IDM domain name based on the values in the configuration
Change {
#[clap(flatten)]
commonopts: CommonOpt,
},
#[clap(name = "raise")]
/// Raise the functional level of this domain to the maximum available.
Raise {
#[clap(flatten)]
commonopts: CommonOpt,
},
#[clap(name = "remigrate")]
/// Rerun migrations of this domains database, optionally nominating the level
/// to start from.
Remigrate {
#[clap(flatten)]
commonopts: CommonOpt,
level: Option<u32>,
},
}
#[derive(Debug, Subcommand)]
enum DbCommands {
#[clap(name = "vacuum")]
/// Vacuum the database to reclaim space or change db_fs_type/page_size (offline)
Vacuum(CommonOpt),
#[clap(name = "backup")]
/// Backup the database content (offline)
Backup(BackupOpt),
#[clap(name = "restore")]
/// Restore the database content (offline)
Restore(RestoreOpt),
#[clap(name = "verify")]
/// Verify database and entity consistency.
Verify(CommonOpt),
#[clap(name = "reindex")]
/// Reindex the database (offline)
Reindex(CommonOpt),
}
#[derive(Debug, Args)]
struct DbScanListIndex {
/// The name of the index to list
index_name: String,
#[clap(flatten)]
commonopts: CommonOpt,
}
#[derive(Debug, Parser)]
struct HealthCheckArgs {
/// Disable TLS verification
#[clap(short, long, action)]
verify_tls: bool,
/// Check the 'origin' URL from the server configuration file, instead of the 'address'
#[clap(short = 'O', long, action)]
check_origin: bool,
#[clap(flatten)]
commonopts: CommonOpt,
}
#[derive(Debug, Args)]
struct DbScanGetId2Entry {
/// The id of the entry to display
id: u64,
#[clap(flatten)]
commonopts: CommonOpt,
}
#[derive(Debug, Subcommand)]
enum DbScanOpt {
#[clap(name = "list-all-indexes")]
/// List all index tables that exist on the system.
ListIndexes(CommonOpt),
#[clap(name = "list-index")]
/// List all content of a named index
ListIndex(DbScanListIndex),
// #[structopt(name = "get_index")]
// /// Display the content of a single index key
// GetIndex(DbScanGetIndex),
#[clap(name = "list-id2entry")]
/// List all id2entry values with reduced entry content
ListId2Entry(CommonOpt),
#[clap(name = "get-id2entry")]
/// View the data of a specific entry from id2entry
GetId2Entry(DbScanGetId2Entry),
#[clap(name = "list-index-analysis")]
/// List all content of index analysis
ListIndexAnalysis(CommonOpt),
#[clap(name = "quarantine-id2entry")]
/// Given an entry id, quarantine the entry in a hidden db partition
QuarantineId2Entry {
/// The id of the entry to display
id: u64,
#[clap(flatten)]
commonopts: CommonOpt,
},
#[clap(name = "list-quarantined")]
/// List the entries in quarantine
ListQuarantined {
#[clap(flatten)]
commonopts: CommonOpt,
},
#[clap(name = "restore-quarantined")]
/// Given an entry id, restore the entry from the hidden db partition
RestoreQuarantined {
/// The id of the entry to display
id: u64,
#[clap(flatten)]
commonopts: CommonOpt,
},
}
#[derive(Debug, Parser)]
#[command(name = "kanidmd")]
struct KanidmdParser {
#[command(subcommand)]
commands: KanidmdOpt,
}
#[derive(Debug, Subcommand)]
enum KanidmdOpt {
#[clap(name = "server")]
/// Start the IDM Server
Server(CommonOpt),
#[clap(name = "configtest")]
/// Test the IDM Server configuration, without starting network listeners.
ConfigTest(CommonOpt),
#[clap(name = "cert-generate")]
/// Create a self-signed ca and tls certificate in the locations listed from the
/// configuration. These certificates should *not* be used in production, they
/// are for testing and evaluation only!
CertGenerate(CommonOpt),
#[clap(name = "recover-account")]
/// Recover an account's password
RecoverAccount {
#[clap(value_parser)]
/// The account name to recover credentials for.
name: String,
#[clap(flatten)]
commonopts: CommonOpt,
},
/// Display this server's replication certificate
ShowReplicationCertificate {
#[clap(flatten)]
commonopts: CommonOpt,
},
/// Renew this server's replication certificate
RenewReplicationCertificate {
#[clap(flatten)]
commonopts: CommonOpt,
},
/// Refresh this servers database content with the content from a supplier. This means
/// that all local content will be deleted and replaced with the supplier content.
RefreshReplicationConsumer {
#[clap(flatten)]
commonopts: CommonOpt,
/// Acknowledge that this database content will be refreshed from a supplier.
#[clap(long = "i-want-to-refresh-this-servers-database")]
proceed: bool,
},
// #[clap(name = "reset_server_id")]
// ResetServerId(CommonOpt),
#[clap(name = "db-scan")]
/// Inspect the internal content of the database datastructures.
DbScan {
#[clap(subcommand)]
commands: DbScanOpt,
},
/// Database maintenance, backups, restoration etc.
#[clap(name = "database")]
Database {
#[clap(subcommand)]
commands: DbCommands,
},
/// Change domain settings
#[clap(name = "domain")]
DomainSettings {
#[clap(subcommand)]
commands: DomainSettingsCmds,
},
/// Load the server config and check services are listening
#[clap(name = "healthcheck")]
HealthCheck(HealthCheckArgs),
/// Print the program version and exit
#[clap(name = "version")]
Version(CommonOpt),
}