/mandos/release : revision 24.1.61

To get this branch, use:

bzr branch
http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

Committer: Björn Påhlsson
Date: 2008-08-24 06:21:51 UTC
mfrom: (96 mandos)
mto: (237.7.1 mandos) (24.1.154 mandos)
mto: This revision was merged to the branch mainline in revision 99.
Revision ID: belorn@braxen-20080824062151-b5me1rgq4lszzt42

merge

files added:
COPYING

initramfs-tools-hook

initramfs-tools-hook-conf

initramfs-tools-script

mandos-keygen

mandos-keygen.xml

mandos-options.xml

overview.xml

plugins.d/usplash

files removed:
network-protocol.txt

files renamed:
mandos-client.c => plugin-runner.c

mandos-client.xml => plugin-runner.xml

files modified:
Makefile

TODO

clients.conf

mandos

mandos-clients.conf.xml

mandos.conf

mandos.conf.xml

mandos.xml

plugins.d/password-prompt.c

plugins.d/password-prompt.xml

plugins.d/password-request.c

plugins.d/password-request.xml

Show diffs side-by-side

added added

removed removed

mandos-keygen.xml

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY VERSION "1.0">

<!ENTITY COMMANDNAME "mandos-keygen">

<title>&COMMANDNAME;</title>

<productname>&COMMANDNAME;</productname>

<productnumber>&VERSION;</productnumber>

<firstname>Björn</firstname>

<surname>Påhlsson</surname>

<email>belorn@fukt.bsnet.se</email>

</address>

</author>

<firstname>Teddy</firstname>

<surname>Hogeborn</surname>

<email>teddy@fukt.bsnet.se</email>

</address>

</author>

</authorgroup>

<holder>Teddy Hogeborn</holder>

<holder>Björn Påhlsson</holder>

</copyright>

<para>

This manual page is free software: you can redistribute it

and/or modify it under the terms of the GNU General Public

License as published by the Free Software Foundation,

either version 3 of the License, or (at your option) any

later version.

</para>

<para>

This manual page is distributed in the hope that it will

be useful, but WITHOUT ANY WARRANTY; without even the

implied warranty of MERCHANTABILITY or FITNESS FOR A

PARTICULAR PURPOSE. See the GNU General Public License

for more details.

</para>

<para>

You should have received a copy of the GNU General Public

License along with this program; If not, see

<ulink url="http://www.gnu.org/licenses/"/>.

</para>

</legalnotice>

</refentryinfo>

<refentrytitle>&COMMANDNAME;</refentrytitle>

</refmeta>

<refname><command>&COMMANDNAME;</command></refname>

Generate keys for <citerefentry><refentrytitle>password-request

</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>

</refpurpose>

</refnamediv>

<command>&COMMANDNAME;</command>

<replaceable>directory</replaceable></arg>

</group>

</group>

<arg choice="plain"><option>--length</option>

</group>

<arg choice="plain"><option>--subtype</option>

</group>

<arg choice="plain"><option>--sublength</option>

</group>

</group>

100

101

<arg choice="plain"><option>--email</option>

102

<replaceable>EMAIL</replaceable></arg>

103

</group>

104

105

<arg choice="plain"><option>--comment</option>

106

<replaceable>COMMENT</replaceable></arg>

107

</group>

108

109

<arg choice="plain"><option>--expire</option>

110

111

</group>

112

113

<arg choice="plain"><option>--force</option></arg>

114

</group>

115

</cmdsynopsis>

116

117

<command>&COMMANDNAME;</command>

118

119

120

<replaceable>directory</replaceable></arg>

121

</group>

122

123

124

125

</group>

126

127

128

129

</group>

130

131

132

133

</group>

134

135

136

137

</group>

138

139

140

141

</group>

142

143

144

<replaceable>EMAIL</replaceable></arg>

145

</group>

146

147

148

<replaceable>COMMENT</replaceable></arg>

149

</group>

150

151

152

153

</group>

154

155

156

</group>

157

</cmdsynopsis>

158

159

<command>&COMMANDNAME;</command>

160

161

162

163

</group>

164

</cmdsynopsis>

165

166

<command>&COMMANDNAME;</command>

167

168

169

<arg choice="plain"><option>--version</option></arg>

170

</group>

171

</cmdsynopsis>

172

</refsynopsisdiv>

173

174

175

<title>DESCRIPTION</title>

176

<para>

177

<command>&COMMANDNAME;</command> is a program to generate the

178

OpenPGP keys used by

179

<citerefentry><refentrytitle>password-request</refentrytitle>

180

<manvolnum>8mandos</manvolnum></citerefentry>. The keys are

181

normally written to /etc/mandos for later installation into the

182

initrd image, but this, like most things, can be changed with

183

command line options.

184

</para>

185

</refsect1>

186

187

188

<title>PURPOSE</title>

189

190

<para>

191

The purpose of this is to enable <emphasis>remote and unattended

192

rebooting</emphasis> of client host computer with an

193

<emphasis>encrypted root file system</emphasis>. See <xref

194

linkend="overview"/> for details.

195

</para>

196

197

</refsect1>

198

199

200

<title>OPTIONS</title>

201

202

203

204

205

206

<para>

207

Show a help message and exit

208

</para>

209

</listitem>

210

</varlistentry>

211

212

213

<term><literal>-d</literal>, <literal>--dir

214

<replaceable>directory</replaceable></literal></term>

215

216

<para>

217

Target directory for key files.

218

</para>

219

</listitem>

220

</varlistentry>

221

222

223

<term><literal>-t</literal>, <literal>--type

224

225

226

<para>

227

Key type. Default is <quote>DSA</quote>.

228

</para>

229

</listitem>

230

</varlistentry>

231

232

233

<term><literal>-l</literal>, <literal>--length

234

235

236

<para>

237

Key length in bits. Default is 1024.

238

</para>

239

</listitem>

240

</varlistentry>

241

242

243

<term><literal>-s</literal>, <literal>--subtype

244

245

246

<para>

247

Subkey type. Default is <quote>ELG-E</quote> (Elgamal

248

encryption-only).

249

</para>

250

</listitem>

251

</varlistentry>

252

253

254

<term><literal>-L</literal>, <literal>--sublength

255

256

257

<para>

258

Subkey length in bits. Default is 2048.

259

</para>

260

</listitem>

261

</varlistentry>

262

263

264

<term><literal>-e</literal>, <literal>--email</literal>

265

<replaceable>address</replaceable></term>

266

267

<para>

268

Email address of key. Default is empty.

269

</para>

270

</listitem>

271

</varlistentry>

272

273

274

<term><literal>-c</literal>, <literal>--comment</literal>

275

<replaceable>comment</replaceable></term>

276

277

<para>

278

Comment field for key. The default value is

279

<quote><literal>Mandos client key</literal></quote>.

280

</para>

281

</listitem>

282

</varlistentry>

283

284

285

<term><literal>-x</literal>, <literal>--expire</literal>

286

287

288

<para>

289

Key expire time. Default is no expiration. See

290

291

<manvolnum>1</manvolnum></citerefentry> for syntax.

292

</para>

293

</listitem>

294

</varlistentry>

295

296

297

<term><literal>-f</literal>, <literal>--force</literal></term>

298

299

<para>

300

Force overwriting old keys.

301

</para>

302

</listitem>

303

</varlistentry>

304

</variablelist>

305

</refsect1>

306

307

308

<title>OVERVIEW</title>

309

<xi:include href="overview.xml"/>

310

<para>

311

This program is a small utility to generate new OpenPGP keys for

312

new Mandos clients.

313

</para>

314

</refsect1>

315

316

317

<title>EXIT STATUS</title>

318

<para>

319

The exit status will be 0 if new keys were successfully created,

320

otherwise not.

321

</para>

322

</refsect1>

323

324

325

<title>ENVIRONMENT</title>

326

327

328

<term><varname>TMPDIR</varname></term>

329

330

<para>

331

If set, temporary files will be created here. See

332

<citerefentry><refentrytitle>mktemp</refentrytitle>

333

<manvolnum>1</manvolnum></citerefentry>.

334

</para>

335

</listitem>

336

</varlistentry>

337

</variablelist>

338

</refsect1>

339

340

341

<title>FILES</title>

342

<para>

343

Use the <option>--dir</option> option to change where

344

<command>&COMMANDNAME;</command> will write the key files. The

345

default file names are shown here.

346

</para>

347

348

349

<term><filename>/etc/mandos/seckey.txt</filename></term>

350

351

<para>

352

OpenPGP secret key file which will be created or

353

overwritten.

354

</para>

355

</listitem>

356

</varlistentry>

357

358

<term><filename>/etc/mandos/pubkey.txt</filename></term>

359

360

<para>

361

OpenPGP public key file which will be created or

362

overwritten.

363

</para>

364

</listitem>

365

</varlistentry>

366

367

368

369

<para>

370

Temporary files will be written here if

371

<varname>TMPDIR</varname> is not set.

372

</para>

373

</listitem>

374

</varlistentry>

375

</variablelist>

376

</refsect1>

377

378

379

380

<para>

381

None are known at this time.

382

</para>

383

</refsect1>

384

385

386

<title>EXAMPLE</title>

387

388

<para>

389

Normal invocation needs no options:

390

</para>

391

<para>

392

<userinput>mandos-keygen</userinput>

393

</para>

394

</informalexample>

395

396

<para>

397

Create keys in another directory and of another type. Force

398

overwriting old key files:

399

</para>

400

<para>

401

402

403

<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>

404

405

</para>

406

</informalexample>

407

</refsect1>

408

409

410

<title>SECURITY</title>

411

<para>

412

The <option>--type</option>, <option>--length</option>,

413

<option>--subtype</option>, and <option>--sublength</option>

414

options can be used to create keys of insufficient security. If

415

in doubt, leave them to the default values.

416

</para>

417

<para>

418

The key expire time is not guaranteed to be honored by

419

<citerefentry><refentrytitle>mandos</refentrytitle>

420

<manvolnum>8</manvolnum></citerefentry>.

421

</para>

422

</refsect1>

423

424

425

426

<para>

427

<citerefentry><refentrytitle>password-request</refentrytitle>

428

<manvolnum>8mandos</manvolnum></citerefentry>,

429

<citerefentry><refentrytitle>mandos</refentrytitle>

430

<manvolnum>8</manvolnum></citerefentry>,

431

432

433

</para>

434

</refsect1>

435

436

</refentry>

Older »