Skip to content

Commit b90270d

Browse files
authored
[MNGSITE-393] Remove pre-Maven 3 comments (#152)
* [MNGSITE-393] Remove pre-Maven 3 comments @eolivelli and generally tighten language * code review
1 parent 23d9e99 commit b90270d

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

content/apt/guides/mini/guide-encryption.apt

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
* {Introduction}
4444

45-
Maven 2.1.0+ now supports server password encryption. The main use case, addressed by this solution is:
45+
Maven supports server password encryption. The main use case, addressed by this solution is:
4646

4747
* multiple users share the same build machine (server, CI box)
4848

@@ -94,21 +94,21 @@ mvn --encrypt-master-password <password>
9494

9595
* {How to encrypt server passwords}
9696

97-
You will have to use the following command line:
97+
You have to use the following command line:
9898

9999
+------------------------------------+
100100
mvn --encrypt-password <password>
101101
+------------------------------------+
102102

103103
<Note:>Just like <<<--encrypt-master-password>>> the password argument should no longer be used since Maven 3.2.1 (see {{{Tips}Tips below for more information.}}).
104104

105-
This command will produce an encrypted version of it, something like
105+
This command produces an encrypted version of it, something like
106106

107107
+------------------------------------+
108108
{COQLCE6DU6GtcS5P=}
109109
+------------------------------------+
110110

111-
Cut-n-paste it into your <<<settings.xml>>> file in the server section. This will look like:
111+
Copy and paste it into the servers section of your <<<settings.xml>>> file. This will look like:
112112

113113
+------------------------------------+
114114
<settings>
@@ -176,30 +176,30 @@ mvn deploy:deploy-file -Durl=https://maven.corp.com/repo \
176176
</settingsSecurity>
177177
+------------------------------------+
178178

179-
This assures that encryption will only work when the usb drive is mounted by OS.
179+
This assures that encryption only works when the USB drive is mounted by the OS.
180180
This addresses a use case where only certain people are authorized to deploy and
181181
are issued these devices.
182182

183183
* {Tips}
184184

185185
** Escaping curly-brace literals in your password <(Since: Maven 2.2.0)>
186186

187-
At times, you might find that your password (or the encrypted form of it) may
188-
actually contain '\{' or '\}' as a literal value. If you added such a password as-is
187+
At times, you might find that your password (or the encrypted form of it)
188+
contains '\{' or '\}' as a literal value. If you added such a password as-is
189189
to your settings.xml file, you would find that Maven does strange things with it.
190-
Specifically, Maven will treat all the characters preceding the '\{' literal, and
190+
Specifically, Maven treats all the characters preceding the '\{' literal, and
191191
all the characters after the '\}' literal, as comments. Obviously, this is not the
192-
behavior you want in such a situation. What you really need is a way of <<escaping>>
192+
behavior you want. What you really need is a way of <<escaping>>
193193
the curly-brace literals in your password.
194194

195-
Starting in Maven 2.2.0, you can do just this, with the widely used '\' escape character.
195+
You can do this with the widely used '\' escape character.
196196
If your password looks like this:
197197

198198
+---+
199199
jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+{EF1iFQyJQ=
200200
+---+
201201

202-
Then, the value you would add to your settings.xml would look like this:
202+
Then, the value you would add to your settings.xml looks like this:
203203

204204
+---+
205205
{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+\{EF1iFQyJQ=}
@@ -221,9 +221,9 @@ jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+{EF1iFQyJQ=
221221

222222
** Password Escaping on different platforms
223223

224-
On some platforms it might be neccessary to quote your password based on the content of your
225-
password in particular having special characters like <<<%>>>, <<<!>>>, <<<$>>> etc. in there.
226-
For example on Windows you have to be carefull about things like the following:
224+
On some platforms it might be necessary to quote the password if it contains
225+
special characters like <<<%>>>, <<<!>>>, <<<$>>>, etc.
226+
For example on Windows you have to be careful about things like the following:
227227

228228
The following example will not work on Windows:
229229

@@ -238,21 +238,21 @@ mvn --encrypt-master-password "a!$%^b"
238238
+----+
239239

240240
If you are on a linux/unix platform you should use single quotes for the above
241-
master password otherwise you will be astonished that the usage of the master-password
242-
will not work (caused by the dollar sign and furthermore the exclamation mark).
241+
master password. Otherwise the master password
242+
will not work (caused by the dollar sign and the exclamation mark).
243243

244244
** Prompting for Password
245245

246-
In Maven before version 3.2.1 you have to give the password on command line as
247-
argument which means you might need to escape your password. In addition
246+
In Maven before version 3.2.1 you have to give the password on the command line as
247+
an argument which means you might need to escape your password. In addition
248248
usually the shell stores the full history of commands you have entered,
249249
therefore anyone with access to your computer could restore the password from
250250
the shell`s history.
251251

252-
Starting with Maven 3.2.1 the password is an optional argument which means if
253-
you omit the password you will be prompted for it which prevents all the issues
252+
Starting with Maven 3.2.1, the password is an optional argument. If
253+
you omit the password, you will be prompted for it which prevents all the issues
254254
mentioned above.
255255

256-
Therefore we strongly recommend to use Maven 3.2.1 and above to prevent
256+
We strongly recommend using Maven 3.2.1 and above to prevent
257257
problems with escaping special characters and of course security issues related
258258
to bash history or environment issues in relationship with the password.

0 commit comments

Comments
 (0)