/mandos/release : revision 88

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: Teddy Hogeborn
Date: 2008-08-18 05:57:11 UTC
Revision ID: teddy@fukt.bsnet.se-20080818055711-2rpzat3hkbq3us62

No code or documentation changes.

files added:
COPYING

initramfs-tools-hook

initramfs-tools-hook-conf

initramfs-tools-script

mandos-keygen

mandos-keygen.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.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">

<!ENTITY OVERVIEW SYSTEM "overview.xml">

<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 & 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>

</group>

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

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

</group>

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

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

</group>

100

101

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

102

103

</group>

104

105

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

106

</group>

107

</cmdsynopsis>

108

109

<command>&COMMANDNAME;</command>

110

111

112

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

113

</group>

114

115

116

117

</group>

118

119

120

121

</group>

122

123

124

125

</group>

126

127

128

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

129

</group>

130

131

132

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

133

</group>

134

135

136

137

</group>

138

139

140

</group>

141

</cmdsynopsis>

142

143

<command>&COMMANDNAME;</command>

144

145

146

147

</group>

148

</cmdsynopsis>

149

150

<command>&COMMANDNAME;</command>

151

152

153

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

154

</group>

155

</cmdsynopsis>

156

</refsynopsisdiv>

157

158

159

<title>DESCRIPTION</title>

160

<para>

161

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

162

OpenPGP keys used by

163

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

164

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

165

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

166

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

167

command line options.

168

</para>

169

</refsect1>

170

171

172

<title>PURPOSE</title>

173

174

<para>

175

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

176

rebooting</emphasis> of client host computer with an

177

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

178

linkend="overview"/> for details.

179

</para>

180

181

</refsect1>

182

183

184

<title>OPTIONS</title>

185

186

187

188

189

190

<para>

191

Show a help message and exit

192

</para>

193

</listitem>

194

</varlistentry>

195

196

197

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

198

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

199

200

<para>

201

Target directory for key files.

202

</para>

203

</listitem>

204

</varlistentry>

205

206

207

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

208

209

210

<para>

211

Key type. Default is DSA.

212

</para>

213

</listitem>

214

</varlistentry>

215

216

217

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

218

219

220

<para>

221

Key length in bits. Default is 1024.

222

</para>

223

</listitem>

224

</varlistentry>

225

226

227

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

228

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

229

230

<para>

231

Email address of key. Default is empty.

232

</para>

233

</listitem>

234

</varlistentry>

235

236

237

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

238

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

239

240

<para>

241

Comment field for key. The default value is

242

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

243

</para>

244

</listitem>

245

</varlistentry>

246

247

248

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

249

250

251

<para>

252

Key expire time. Default is no expiration. See

253

254

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

255

</para>

256

</listitem>

257

</varlistentry>

258

259

260

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

261

262

<para>

263

Force overwriting old keys.

264

</para>

265

</listitem>

266

</varlistentry>

267

</variablelist>

268

</refsect1>

269

270

271

<title>OVERVIEW</title>

272

&OVERVIEW;

273

<para>

274

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

275

new Mandos clients.

276

</para>

277

</refsect1>

278

279

280

<title>EXIT STATUS</title>

281

<para>

282

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

283

otherwise not.

284

</para>

285

</refsect1>

286

287

288

<title>ENVIRONMENT</title>

289

290

291

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

292

293

<para>

294

If set, temporary files will be created here. See

295

<citerefentry><refentrytitle>mktemp</refentrytitle>

296

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

297

</para>

298

</listitem>

299

</varlistentry>

300

</variablelist>

301

</refsect1>

302

303

304

<title>FILES</title>

305

<para>

306

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

307

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

308

default file names are shown here.

309

</para>

310

311

312

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

313

314

<para>

315

OpenPGP secret key file which will be created or

316

overwritten.

317

</para>

318

</listitem>

319

</varlistentry>

320

321

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

322

323

<para>

324

OpenPGP public key file which will be created or

325

overwritten.

326

</para>

327

</listitem>

328

</varlistentry>

329

330

331

332

<para>

333

Temporary files will be written here if

334

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

335

</para>

336

</listitem>

337

</varlistentry>

338

</variablelist>

339

</refsect1>

340

341

342

343

<para>

344

None are known at this time.

345

</para>

346

</refsect1>

347

348

349

<title>EXAMPLE</title>

350

351

<para>

352

Normal invocation needs no options:

353

</para>

354

<para>

355

<userinput>mandos-keygen</userinput>

356

</para>

357

</informalexample>

358

359

<para>

360

Create keys in another directory and of another type. Force

361

overwriting old key files:

362

</para>

363

<para>

364

365

366

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

367

368

</para>

369

</informalexample>

370

</refsect1>

371

372

373

<title>SECURITY</title>

374

<para>

375

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

376

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

377

in doubt, leave them to the default values.

378

</para>

379

<para>

380

The key expire time is not guaranteed to be honored by

381

<citerefentry><refentrytitle>mandos</refentrytitle>

382

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

383

</para>

384

</refsect1>

385

386

387

388

<para>

389

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

390

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

391

<citerefentry><refentrytitle>mandos</refentrytitle>

392

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

393

394

395

</para>

396

</refsect1>

397

398

</refentry>

Older »