/mandos/trunk

« back to all changes in this revision

Viewing changes to plugins.d/password-prompt.xml

• browse files at revision 24.1.183
• compare with another revision
• download diff
• download tarball
• view history from revision 24.1.183

• reverse the comparison (24.1.183 to 121)
• stop comparing with revision 121

Show diffs side-by-side

added

removed

plugins.d/password-prompt.xml

1

1

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

2

2

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

3

3

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

4

 

<!ENTITY VERSION "1.0">

5

4

<!ENTITY COMMANDNAME "password-prompt">

6

 

<!ENTITY TIMESTAMP "2008-08-30">

 

5

<!ENTITY TIMESTAMP "2011-08-08">

 

6

<!ENTITY % common SYSTEM "../common.ent">

 

7

%common;

7

8

]>

8

9

 

9

 

<refentry>

 

10

<refentry xmlns:xi="http://www.w3.org/2001/XInclude">

10

11

  <refentryinfo>

11

12

    <title>Mandos Manual</title>

12

13

    <!-- NWalsh’s docbook scripts use this to generate the footer: -->

13

14

    <productname>Mandos</productname>

14

 

    <productnumber>&VERSION;</productnumber>

 

15

    <productnumber>&version;</productnumber>

15

16

    <date>&TIMESTAMP;</date>

16

17

    <authorgroup>

17

18

      <author>

31

32

    </authorgroup>

32

33

    <copyright>

33

34

      <year>2008</year>

 

35

      <year>2009</year>

 

36

      <year>2011</year>

34

37

      <holder>Teddy Hogeborn</holder>

35

38

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

36

39

    </copyright>

37

 

    <legalnotice>

38

 

      <para>

39

 

        This manual page is free software: you can redistribute it

40

 

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

41

 

        License as published by the Free Software Foundation,

42

 

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

43

 

        later version.

44

 

      </para>

45

 

      

46

 

      <para>

47

 

        This manual page is distributed in the hope that it will

48

 

        be useful, but WITHOUT ANY WARRANTY; without even the

49

 

        implied warranty of MERCHANTABILITY or FITNESS FOR A

50

 

        PARTICULAR PURPOSE.  See the GNU General Public License

51

 

        for more details.

52

 

      </para>

53

 

      

54

 

      <para>

55

 

        You should have received a copy of the GNU General Public

56

 

        License along with this program; If not, see

57

 

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

58

 

      </para>

59

 

    </legalnotice>

 

40

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

60

41

  </refentryinfo>

61

42

  

62

43

  <refmeta>

73

54

    <cmdsynopsis>

74

55

      <command>&COMMANDNAME;</command>

75

56

      <group choice="opt">

76

 

        <arg choice="plain"><option>-p <replaceable

 

57

        <arg choice="plain"><option>--prefix <replaceable

77

58

        >PREFIX</replaceable></option></arg>

78

 

        <arg choice="plain"><option>--prefix </option><replaceable

 

59

        <arg choice="plain"><option>-p </option><replaceable

79

60

        >PREFIX</replaceable></arg>

80

61

      </group>

 

62

      <sbr/>

81

63

      <arg choice="opt"><option>--debug</option></arg>

82

64

    </cmdsynopsis>

83

65

    <cmdsynopsis>

84

66

      <command>&COMMANDNAME;</command>

85

67

      <group choice="req">

 

68

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

86

69

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

87

 

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

88

70

      </group>

89

71

    </cmdsynopsis>

90

72

    <cmdsynopsis>

94

76

    <cmdsynopsis>

95

77

      <command>&COMMANDNAME;</command>

96

78

      <group choice="req">

 

79

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

97

80

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

98

 

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

99

81

      </group>

100

82

    </cmdsynopsis>

101

83

  </refsynopsisdiv>

104

86

    <title>DESCRIPTION</title>

105

87

    <para>

106

88

      All <command>&COMMANDNAME;</command> does is prompt for a

107

 

      password and output any given password to standard output.  This

108

 

      is not very useful on its own.  This program is really meant to

109

 

      run as a plugin in the <application>Mandos</application>

110

 

      client-side system, where it is used as a fallback and

111

 

      alternative to retriving passwords from a <application

112

 

      >Mandos</application> server.

 

89

      password and output any given password to standard output.

 

90

    </para>

 

91

    <para>

 

92

      This program is not very useful on its own.  This program is

 

93

      really meant to run as a plugin in the <application

 

94

      >Mandos</application> client-side system, where it is used as a

 

95

      fallback and alternative to retrieving passwords from a

 

96

      <application >Mandos</application> server.

113

97

    </para>

114

98

    <para>

115

99

      This program is little more than a <citerefentry><refentrytitle

133

117

    

134

118

    <variablelist>

135

119

      <varlistentry>

136

 

        <term><option>-p</option> <replaceable>PREFIX</replaceable

137

 

        ></term>

138

 

        <term><option>--prefix=</option><replaceable

139

 

        >PREFIX</replaceable></term>

 

120

        <term><option>--prefix=<replaceable

 

121

        >PREFIX</replaceable></option></term>

 

122

        <term><option>-p

 

123

        <replaceable>PREFIX</replaceable></option></term>

140

124

        <listitem>

141

125

          <para>

142

126

            Prefix string shown before the password prompt.

156

140

      </varlistentry>

157

141

      

158

142

      <varlistentry>

 

143

        <term><option>--help</option></term>

159

144

        <term><option>-?</option></term>

160

 

        <term><option>--help</option></term>

161

145

        <listitem>

162

146

          <para>

163

147

            Gives a help message about options and their meanings.

175

159

      </varlistentry>

176

160

      

177

161

      <varlistentry>

 

162

        <term><option>--version</option></term>

178

163

        <term><option>-V</option></term>

179

 

        <term><option>--version</option></term>

180

164

        <listitem>

181

165

          <para>

182

166

            Prints the program version.

200

184

    <title>ENVIRONMENT</title>

201

185

    <variablelist>

202

186

      <varlistentry>

203

 

        <term><envar>cryptsource</envar></term>

204

 

        <term><envar>crypttarget</envar></term>

 

187

        <term><envar>CRYPTTAB_SOURCE</envar></term>

 

188

        <term><envar>CRYPTTAB_NAME</envar></term>

205

189

        <listitem>

206

190

          <para>

207

191

            If set, these environment variables will be assumed to

215

199

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

216

200

          normally have inherited them from

217

201

          <filename>/scripts/local-top/cryptroot</filename> in the

218

 

          initial RAM disk environment, which will have set them from

219

 

          parsing kernel arguments and

 

202

          initial <acronym>RAM</acronym> disk environment, which will

 

203

          have set them from parsing kernel arguments and

220

204

          <filename>/conf/conf.d/cryptroot</filename> (also in the

221

205

          initial RAM disk environment), which in turn will have been

222

206

          created when the initial RAM disk image was created by

261

245

      <para>

262

246

        Show a prefix before the prompt; in this case, a host name.

263

247

        It might be useful to be reminded of which host needs a

264

 

        password, in case of KVM switches, etc.

 

248

        password, in case of <acronym>KVM</acronym> switches, etc.

265

249

      </para>

266

250

      <para>

267

251

 

291

275

      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>

292

276

      </citerefentry>, and will, when run standalone, outside, in a

293

277

      normal environment, immediately output on its standard output

294

 

      any presumably secret password it just recieved.  Therefore,

 

278

      any presumably secret password it just received.  Therefore,

295

279

      when running this program standalone (which should never

296

280

      normally be done), take care not to type in any real secret

297

281

      password by force of habit, since it would then immediately be

309

293

  <refsect1 id="see_also">

310

294

    <title>SEE ALSO</title>

311

295

    <para>

 

296

      <citerefentry><refentrytitle>intro</refentrytitle>

 

297

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

312

298

      <citerefentry><refentrytitle>crypttab</refentrytitle>

313

299

      <manvolnum>5</manvolnum></citerefentry>

314

 

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

 

300

      <citerefentry><refentrytitle>mandos-client</refentrytitle>

315

301

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

316

302

      <citerefentry><refentrytitle>plugin-runner</refentrytitle>

317

303

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

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0