質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.82%

MavenでBasic認証をしてアーティファクトをNexusにデプロイしたい

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 1,071

d_tutuz

score 545

実現したいこと

Apache Maven Deploy Plugin で Basic 認証をしてアーティファクトをデプロイしたい

詳細

Jenkins Pipeline から Gradle を用いた Java プロジェクトのアーティファクト(jar)を Nexus3 のアーティファクトリポジトリに Publish しようと考えています。
Nexus3 にデプロイするには Basic 認証が必要です。

ここでは仮として Nexus3 に以下のユーザ(とパスワード)が存在するとします。

ユーザ:sample
パスワード:P@sswor$

当初はパスワードがより簡易なもの( Password )などであったため、以下のようにホスト名の前にユーザとパスワードを記述して Jenkins Pipeline からデプロイをしていました。

    sh "mvn deploy:deploy-file \
        -DgroupId=sampleGroup \
        -DartifactId=sampleArtifact \
        -Dversion=0.0.1-SNAPSHOT \
        -Durl=http://${username}:${password}@localhost:8081/repository/maven-snapshots \
        -Dfile=sample.jar \
    "

問題はパスワードが P@sswor$ になったときです。上記のスクリプトでは認証エラー (Not authorized) になってしまいました。

以下はエラーログの一部です。

(http://****:****@localhost:8081/repository/maven-snapshots): Not authorized
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.165 s
[INFO] Finished at: 2019-08-06T18:25:36Z
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-deploy-plugin:2.7:deploy-file (default-cli) on project standalone-pom: Failed to retrieve remote metadata sampleGroup:sampleArtifact:0.0.1-SNAPSHOT/maven-metadata.xml: Could not transfer metadata sampleGroup:sampleArtifact:0.0.1-SNAPSHOT/maven-metadata.xml from/to remote-repository (http://****:****@localhost:8081/repository/maven-snapshots): Not authorized -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

調査/確認事項

私が考えている認証エラーになる原因は RFC 3986 にもあるように URL に @ や $ といった予約文字を含む場合はパーセントエンコードが必要ですが、できていないこと。と考えています。

ただし単純にパスワードをパーセントエンコードした組み合わせ (この例でいうと sample と P%40sswor%24 で -Durl=http://sample:P%40sswor%24@${nexusUrl}/repository/maven-snapshots ) では正常に認証できませんでした。

暫定的な対応案として、デプロイ時のみ以下のように JenkinsPipeline のなかで settings.xml を生成して

sh """
cat <<EOF > ${configPath}
<?xml version="1.0" encoding="UTF-8"?>
    <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <servers>
        <server>
            <id>repo</id>
            <username>${username}</username>
            <password>${password}</password>
        </server>
    </servers>
</settings>
EOF
"""

それを以下のように Apache Maven Deploy Plugin で

mvn deploy:deploy-file ... -DrepositoryId=repo -s settings.xml

として読み込ませることで、認証してデプロイできることは確認できました。
しかし Jenkins に保持している Nexus3 の認証情報を settings.xml に書き出すことは微妙です(スクリプト終了時に rm -f settings.xml などとして削除するとしても)。

公式のドキュメント https://maven.apache.org/plugins/maven-deploy-plugin/deploy-file-mojo.html を見る限り、settings.xml に記述した repositoryId を用いるしかないのでしょうか?

良い方法があれば教えていただきたいですm(_ _)m
宜しくおねがいします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

check解決した方法

+1

自己解決しました!参照していただきありがとうございます!!

以下の 2 点を実施することで解決しました。

1. JENKINS_HOME/.m2/settings.xml の作成

JENKINS_HOME/.m2/ に settings.xml を以下のように作成します。

<?xml version="1.0" encoding="UTF-8"?>
    <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://w                                                                                                                                   ww.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/S                                                                                                                                   ETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <servers>
        <server>
            <id>repo</id>
            <username>${username}</username>
            <password>${password}</password>
        </server>
    </servers>
</settings>

2.mvn のパラメータの設定

以下のようにすることで mvn の Deploy 時にパラメータとしてユーザとパスワードを指定することができます。デプロイできることも確認できました。

mvn deploy:deploy-file ... -DrepositoryId=repo -Pusername=${user} -Ppassword=${pass}

余談

まとめると、公式サイト に記述されていることを実現したことになりますね...

<repositoryId>
Server Id to map on the <id> under <server> section of settings.xml In most cases, this parameter will be required for authentication.

Type: java.lang.String
Required: Yes
User Property: repositoryId
Default: remote-repository

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.82%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る