/mandos/release : revision 95

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-23 07:17:28 UTC
Revision ID: teddy@fukt.bsnet.se-20080823071728-wo1k2mtbje5910np

* Makefile (MANPOST): Bug fix: corrected patterns.

* mandos-options.xml: Bug fix: also change root node tag name in
DOCTYPE declaration.
(interface, address): Improved wording.

* overview.xml: Changed "host computer" to "computer".

files added:
COPYING

initramfs-tools-hook

initramfs-tools-hook-conf

initramfs-tools-script

mandos-clients.conf.xml

mandos-keygen

mandos-keygen.xml

mandos-options.xml

mandos.conf.xml

mandos.xml

overview.xml

plugin-runner.xml

plugins.d/password-prompt.xml

plugins.d/password-request.xml

plugins.d/usplash

files removed:
network-protocol.txt

files renamed:
server.py => mandos

server.conf => mandos.conf

plugbasedclient.c => plugin-runner.c

plugins.d/passprompt.c => plugins.d/password-prompt.c

plugins.d/mandosclient.c => plugins.d/password-request.c

files modified:
Makefile

TODO

clients.conf

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

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

101

102

</group>

103

104

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

105

</group>

106

</cmdsynopsis>

107

108

<command>&COMMANDNAME;</command>

109

110

111

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

112

</group>

113

114

115

116

</group>

117

118

119

120

</group>

121

122

123

124

</group>

125

126

127

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

128

</group>

129

130

131

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

132

</group>

133

134

135

136

</group>

137

138

139

</group>

140

</cmdsynopsis>

141

142

<command>&COMMANDNAME;</command>

143

144

145

146

</group>

147

</cmdsynopsis>

148

149

<command>&COMMANDNAME;</command>

150

151

152

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

153

</group>

154

</cmdsynopsis>

155

</refsynopsisdiv>

156

157

158

<title>DESCRIPTION</title>

159

<para>

160

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

161

OpenPGP keys used by

162

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

163

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

164

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

165

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

166

command line options.

167

</para>

168

</refsect1>

169

170

171

<title>PURPOSE</title>

172

173

<para>

174

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

175

rebooting</emphasis> of client host computer with an

176

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

177

linkend="overview"/> for details.

178

</para>

179

180

</refsect1>

181

182

183

<title>OPTIONS</title>

184

185

186

187

188

189

<para>

190

Show a help message and exit

191

</para>

192

</listitem>

193

</varlistentry>

194

195

196

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

197

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

198

199

<para>

200

Target directory for key files.

201

</para>

202

</listitem>

203

</varlistentry>

204

205

206

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

207

208

209

<para>

210

Key type. Default is DSA.

211

</para>

212

</listitem>

213

</varlistentry>

214

215

216

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

217

218

219

<para>

220

Key length in bits. Default is 1024.

221

</para>

222

</listitem>

223

</varlistentry>

224

225

226

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

227

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

228

229

<para>

230

Email address of key. Default is empty.

231

</para>

232

</listitem>

233

</varlistentry>

234

235

236

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

237

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

238

239

<para>

240

Comment field for key. The default value is

241

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

242

</para>

243

</listitem>

244

</varlistentry>

245

246

247

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

248

249

250

<para>

251

Key expire time. Default is no expiration. See

252

253

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

254

</para>

255

</listitem>

256

</varlistentry>

257

258

259

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

260

261

<para>

262

Force overwriting old keys.

263

</para>

264

</listitem>

265

</varlistentry>

266

</variablelist>

267

</refsect1>

268

269

270

<title>OVERVIEW</title>

271

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

272

<para>

273

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

274

new Mandos clients.

275

</para>

276

</refsect1>

277

278

279

<title>EXIT STATUS</title>

280

<para>

281

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

282

otherwise not.

283

</para>

284

</refsect1>

285

286

287

<title>ENVIRONMENT</title>

288

289

290

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

291

292

<para>

293

If set, temporary files will be created here. See

294

<citerefentry><refentrytitle>mktemp</refentrytitle>

295

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

296

</para>

297

</listitem>

298

</varlistentry>

299

</variablelist>

300

</refsect1>

301

302

303

<title>FILES</title>

304

<para>

305

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

306

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

307

default file names are shown here.

308

</para>

309

310

311

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

312

313

<para>

314

OpenPGP secret key file which will be created or

315

overwritten.

316

</para>

317

</listitem>

318

</varlistentry>

319

320

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

321

322

<para>

323

OpenPGP public key file which will be created or

324

overwritten.

325

</para>

326

</listitem>

327

</varlistentry>

328

329

330

331

<para>

332

Temporary files will be written here if

333

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

334

</para>

335

</listitem>

336

</varlistentry>

337

</variablelist>

338

</refsect1>

339

340

341

342

<para>

343

None are known at this time.

344

</para>

345

</refsect1>

346

347

348

<title>EXAMPLE</title>

349

350

<para>

351

Normal invocation needs no options:

352

</para>

353

<para>

354

<userinput>mandos-keygen</userinput>

355

</para>

356

</informalexample>

357

358

<para>

359

Create keys in another directory and of another type. Force

360

overwriting old key files:

361

</para>

362

<para>

363

364

365

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

366

367

</para>

368

</informalexample>

369

</refsect1>

370

371

372

<title>SECURITY</title>

373

<para>

374

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

375

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

376

in doubt, leave them to the default values.

377

</para>

378

<para>

379

The key expire time is not guaranteed to be honored by

380

<citerefentry><refentrytitle>mandos</refentrytitle>

381

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

382

</para>

383

</refsect1>

384

385

386

387

<para>

388

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

389

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

390

<citerefentry><refentrytitle>mandos</refentrytitle>

391

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

392

393

394

</para>

395

</refsect1>

396

397

</refentry>

Older »