org.wildfly.security.x500.cert.acme.AcmeChallenge Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2018 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wildfly.security.x500.cert.acme;
import static org.wildfly.security.x500.cert.acme.Acme.base64UrlEncode;
import static org.wildfly.security.x500.cert.acme.Acme.getJwk;
import static org.wildfly.security.x500.cert.acme.ElytronMessages.acme;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import javax.json.JsonObject;
import org.wildfly.common.Assert;
import org.wildfly.common.iteration.CodePointIterator;
/**
* A class that represents an Automatic Certificate
* Management Environment (ACME) challenge.
*
* @author Farah Juma
* @since 1.5.0
*/
public final class AcmeChallenge {
private final Type type;
private final String url;
private final String token;
private final String identifierType;
private final String identifierValue;
/**
* Construct a new instance.
*
* @param type the challenge type (must not be {@code null})
* @param url the challenge URL (must not be {@code null})
* @param token the challenge token (must not be {@code null})
* @param identifierType the identifier type associated with the challenge (must not be {@code null})
* @param identifierValue the identifier value associated with the challenge (must not be {@code null})
*/
public AcmeChallenge(Type type, String url, String token, String identifierType, String identifierValue) {
Assert.checkNotNullParam("type", type);
Assert.checkNotNullParam("url", url);
Assert.checkNotNullParam("token", token);
Assert.checkNotNullParam("identifierType", identifierType);
Assert.checkNotNullParam("identifierValue", identifierValue);
this.type = type;
this.url = url;
this.token = token;
this.identifierType = identifierType;
this.identifierValue = identifierValue;
}
/**
* Get the challenge type.
*
* @return the challenge type
*/
public Type getType() {
return type;
}
/**
* Get the challenge URL.
*
* @return the challenge URL
*/
public String getUrl() {
return url;
}
/**
* Get the challenge token.
*
* @return the challenge token
*/
public String getToken() {
return token;
}
/**
* Get the identifier type associated with the challenge.
*
* @return the identifier type associated with the challenge
*/
public String getIdentifierType() {
return identifierType;
}
/**
* Get the identifier value associated with the challenge.
*
* @return the identifier value associated with the challenge
*/
public String getIdentifierValue() {
return identifierValue;
}
/**
* Get the key authorization string for this challenge.
*
* @param account the ACME account information to use (must not be {@code null})
* @return the key authorization string for this challenge
* @throws AcmeException if the key authorization string cannot be determined
*/
public String getKeyAuthorization(AcmeAccount account) throws AcmeException {
Assert.checkNotNullParam("account", account);
JsonObject jwk = getJwk(account.getPublicKey(), account.getAlgHeader());
byte[] jwkWithoutWhitespace = CodePointIterator.ofString(jwk.toString()).skip(Character::isWhitespace).skipCrLf().asUtf8().drain();
try {
MessageDigest messageDigest = MessageDigest.getInstance("SHA-256");
messageDigest.update(jwkWithoutWhitespace);
byte[] jwkThumbprint = messageDigest.digest();
return token + "." + base64UrlEncode(jwkThumbprint);
} catch (NoSuchAlgorithmException e) {
throw acme.unableToDetermineKeyAuthorizationString(e);
}
}
/**
* An Automatic Certificate Management Environment (ACME) challenge type.
*/
public static class Type {
/**
* The various Automatic Certificate Management Environment (ACME) challenge types.
*/
public static final Type HTTP_01 = new Type("http-01");
public static final Type DNS_01 = new Type("dns-01");
public static final Type TLS_SNI_01 = new Type("tls-sni-01");
public static final Type TLS_SNI_02 = new Type("tls-sni-02");
public static final Type TLS_ALPN_01 = new Type("tls-alpn-01");
private final String value;
Type(String value) {
this.value = value;
}
/**
* Get the string value of this challenge type.
*
* @return the string value of this challenge type
*/
public String getValue() {
return value;
}
static Type forName(String name) {
switch (name) {
case "http-01": return HTTP_01;
case "dns-01": return DNS_01;
case "tls-sni-01": return TLS_SNI_01;
case "tls-sni-02": return TLS_SNI_02;
case "tls-alpn-01": return TLS_ALPN_01;
default: return new UnknownType(name);
}
}
}
/**
* An unknown challenge type.
*/
public static class UnknownType extends Type {
UnknownType(String value) {
super(value);
}
}
}