Skip to content

Add support for GPG #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jaredpetersen wants to merge 20 commits into from
Closed

Add support for GPG #59

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
798fdae
Added support for GPG
jaredpetersen May 2, 2020
9db208f
Small passphrase test data fix
jaredpetersen May 2, 2020
23f6cd3
set private key to secret
jaredpetersen May 2, 2020
14d3f1d
fixed generated settings
jaredpetersen May 2, 2020
01f7e3b
changed gpg import to run in key directory
jaredpetersen May 2, 2020
e09c5c7
fixed configAuthentication invokation
jaredpetersen May 2, 2020
1a5aa64
fixed a problem where key cleanup happened before import
jaredpetersen May 3, 2020
c6f4f07
remove test file
jaredpetersen May 3, 2020
9098ec5
updated readme
jaredpetersen May 3, 2020
1d7ec38
changed passhprase configuration to be more in line with docs
jaredpetersen May 3, 2020
4eb5c87
fixed gpg private key description in action.yml
jaredpetersen May 10, 2020
254f003
improved gpg test preciseness
jaredpetersen May 10, 2020
1ecbe18
use runner temp for private key directory
jaredpetersen May 11, 2020
5e3159d
created separate util module
jaredpetersen May 12, 2020
8bc07f9
selective generation of settings for GPG + isolated gpg homedir
jaredpetersen May 12, 2020
430dc5d
specified homedir in executable
jaredpetersen May 12, 2020
6e0fcb3
fixed homedir path
jaredpetersen May 12, 2020
ebb46ea
forgot to build and lint
jaredpetersen May 12, 2020
11c39b6
hopefully fixed util tests
jaredpetersen May 12, 2020
1607b0d
trying to force gpg homedir to posix for windows to fix windows impor…
jaredpetersen May 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
changed passhprase configuration to be more in line with docs
  • Loading branch information
@jaredpetersen
jaredpetersen committed May 3, 2020
commit 1d7ec38fd8fcd4fa0b522a1fc52d1b291baa8107
28 changes: 8 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,16 +134,10 @@ The two `settings.xml` files created from the above example look like the follow
<username>${env.GITHUB_ACTOR}</username>
<password>${env.GITHUB_TOKEN}</password>
</server>
<profiles>
<profile>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<gpg.passphrase>${env.GPG_PASSPHRASE}</gpg.passphrase>
</properties>
</profile>
<profiles>
<server>
<id>gpg.passphrase</id>
<passphrase>${env.GPG_PASSPHRASE}</passphrase>
</server>
</servers>
```

Expand All @@ -155,16 +149,10 @@ The two `settings.xml` files created from the above example look like the follow
<username>${env.MAVEN_USERNAME}</username>
<password>${env.MAVEN_CENTRAL_TOKEN}</password>
</server>
<profiles>
<profile>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<gpg.passphrase>${env.MAVEN_GPG_PASSPHRASE}</gpg.passphrase>
</properties>
</profile>
<profiles>
<server>
<id>gpg.passphrase</id>
<passphrase>${env.MAVEN_GPG_PASSPHRASE}</passphrase>
</server>
</servers>
```

Expand Down
14 changes: 4 additions & 10 deletions __tests__/auth.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,17 +157,11 @@ describe('auth tests', () => {
<username>\${env.${username}}</username>
<password>\${env.&amp;&lt;&gt;&quot;&apos;&apos;&quot;&gt;&lt;&amp;}</password>
</server>
<server>
<id>gpg.passphrase</id>
<passphrase>\${env.${gpgPassphrase}}</passphrase>
</server>
</servers>
<profiles>
<profile>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<gpg.passphrase>\${env.${gpgPassphrase}}</gpg.passphrase>
</properties>
</profile>
</profiles>
</settings>
`);
});
Expand Down
14 changes: 4 additions & 10 deletions dist/index.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 4 additions & 10 deletions src/auth.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,11 @@ export function generate(
<username>\${env.${escapeXML(username)}}</username>
<password>\${env.${escapeXML(password)}}</password>
</server>
<server>

@joshmgross joshmgross May 8, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a user doesn't specify a GPG key, won't this be empty?

Will that cause issues for users who don't want GPG authentication

@jaredpetersen jaredpetersen May 9, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users will see the following by default whether they want GPG authentication or not:

<settings>
    <servers>
      <server>
        <id>github</id>
        <username>${env.GITHUB_ACTOR}</username>
        <password>${env.GITHUB_TOKEN}</password>
      </server>
      <server>
        <id>gpg.passphrase</id>
        <passphrase>${env.GPG_PASSPHRASE}</passphrase>
      </server>
    </servers>
</settings>

And GPG_PASSPHRASE won't be provided so it will be empty string. This isn't a problem for users that don't want GPG -- maven will behave normally and will only grab information from this other server config if it needs it for the GPG plugin.

<id>gpg.passphrase</id>
<passphrase>\${env.${escapeXML(gpgPassphrase)}}</passphrase>
</server>
</servers>
<profiles>
<profile>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<gpg.passphrase>\${env.${escapeXML(gpgPassphrase)}}</gpg.passphrase>
</properties>
</profile>
</profiles>
</settings>
`;
}
Expand Down