coheigea commented on a change in pull request #462: Httpsig URL: https://github.com/apache/cxf/pull/462#discussion_r242218999
########## File path: rt/rs/security/http-signature/src/main/java/org/apache/cxf/rs/security/httpsignature/MessageVerifier.java ########## @@ -0,0 +1,245 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.cxf.rs.security.httpsignature; + +import java.nio.charset.StandardCharsets; +import java.security.Key; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.security.Security; +import java.util.*; +import java.util.logging.Logger; + +import org.apache.cxf.common.logging.LogUtils; +import org.tomitribe.auth.signatures.Signature; +import org.tomitribe.auth.signatures.Verifier; + + +public class MessageVerifier { + private static final Logger LOG = LogUtils.getL7dLogger(MessageVerifier.class); + + private AlgorithmProvider algorithmProvider; + private ExceptionHandler exceptionHandler; + private PublicKeyProvider publicKeyProvider; + private SecurityProvider securityProvider; + + private boolean verifyMessageBody; + + public MessageVerifier(boolean verifyMessageBody) { + this.exceptionHandler = (exception, type) -> new SignatureException("exception of type: " + type + " occurred"); + this.securityProvider = keyId -> Security.getProvider("SunRsaSign"); + this.algorithmProvider = keyId -> DefaultSignatureConstants.SIGNING_ALGORITHM; + this.verifyMessageBody = verifyMessageBody; + } + + public MessageVerifier(PublicKeyProvider publicKeyProvider, + ExceptionHandler exceptionHandler, + SecurityProvider securityProvider, + AlgorithmProvider algorithmProvider, + boolean verifyMessageBody) { + Objects.requireNonNull(publicKeyProvider, "public key provider cannot be null"); + Objects.requireNonNull(exceptionHandler, "exception handler cannot be null"); + Objects.requireNonNull(securityProvider, "security provider cannot be null"); + Objects.requireNonNull(algorithmProvider, "algorithm provider cannot be null"); + this.publicKeyProvider = publicKeyProvider; + this.exceptionHandler = exceptionHandler; + this.securityProvider = securityProvider; + this.algorithmProvider = algorithmProvider; + this.verifyMessageBody = verifyMessageBody; + } + + /** + * @return a map of the headers included in the signature + */ + private static Map<String, List<String>> extractHeaders(Map<String, List<String>> allHeaders) { + assert allHeaders != null && allHeaders.containsKey("Signature") && allHeaders.get("Signature").size() == 1; + + final String signature = allHeaders.get("Signature").get(0); + String headerList = new Scanner(signature).findWithinHorizon("headers=\"[^,]+\"", 0); + headerList = headerList.substring("headers=".length() + 1); // Trim off prefix + headerList = headerList.substring(0, headerList.length() - 1); // Trim off trailing quote + + Map<String, List<String>> headers = new HashMap<>(); + for (String headerName : headerList.split(" ")) { + for (String possibleMatch : allHeaders.keySet()) { + if (possibleMatch.equalsIgnoreCase(headerName)) { + headers.put(possibleMatch, allHeaders.get(possibleMatch)); + } + } + } + + return headers; + } + + public void setSecurityProvider(SecurityProvider securityProvider) { + this.securityProvider = securityProvider; + } + + public void setPublicKeyProvider(PublicKeyProvider publicKeyProvider) { + this.publicKeyProvider = publicKeyProvider; + } + + public void setAlgorithmProvider(AlgorithmProvider algorithmProvider) { + this.algorithmProvider = algorithmProvider; + } + + public ExceptionHandler getExceptionHandler() { + return exceptionHandler; + } + + public void setExceptionHandler(ExceptionHandler exceptionHandler) { + this.exceptionHandler = exceptionHandler; + } + + public void verifyMessage(Map<String, List<String>> messageHeaders, String messageBody) { + if (verifyMessageBody) { + inspectDigest(messageBody, messageHeaders); + } + verifyMessage(messageHeaders); + } + + public void verifyMessage(Map<String, List<String>> messageHeaders) { + inspectIllegalState(); + + inspectMissingSignatureHeader(messageHeaders); + + inspectMultipleSignatureHeaders(messageHeaders); + + Signature signature = extractSignature(messageHeaders.get("Signature").get(0)); + + String providedAlgorithm = algorithmProvider.getAlgorithmName(signature.getKeyId()); + Objects.requireNonNull(providedAlgorithm, "provided algorithm is null"); + + String signatureAlgorithm = signature.getAlgorithm().toString(); + if (!providedAlgorithm.equals(signatureAlgorithm)) { + throw exceptionHandler.handle(new SignatureException("algorithm from header and provided are different"), + SignatureExceptionType.DIFFERENT_ALGORITHMS); + } + + // Replace the algorithm provided by the headers with the algorithm given by the algorithm provider + Signature newSignature = + Signature.fromString(replaceAlgorithm(signature.toString(), signatureAlgorithm, providedAlgorithm)); + + Key key = publicKeyProvider.getKey(signature.getKeyId()); + Objects.requireNonNull(key, "provided public key is null"); + + runVerifier(extractHeaders(messageHeaders), key, newSignature); + } + + private String replaceAlgorithm(String signatureString, String oldAlgorithm, String newAlgorithm) { + return signatureString.replaceFirst("algorithm=\"" + oldAlgorithm, "algorithm=\"" + newAlgorithm); + } + + private void inspectIllegalState() { + if (publicKeyProvider == null) { + throw new IllegalStateException("public key provider is not set"); + } + if (exceptionHandler == null) { + throw new IllegalStateException("exception handler is not set"); + } + if (securityProvider == null) { + throw new IllegalStateException("security provider is not set"); + } + if (algorithmProvider == null) { + throw new IllegalStateException("algorithm provider is not set"); + } + } + + private void inspectDigest(String messageBody, Map<String, List<String>> responseHeaders) { + LOG.fine("Starting digest verification"); + if (responseHeaders.containsKey("Digest")) { + String headerDigest = responseHeaders.get("Digest").get(0); + + MessageDigest messageDigest = getDigestAlgorithm(headerDigest); + messageDigest.update(messageBody.getBytes(StandardCharsets.UTF_8)); + String generatedDigest = new String(messageDigest.digest()); + + headerDigest = new String(Base64.getDecoder().decode(trimAlgorithmName(headerDigest))); + + if (!generatedDigest.equals(headerDigest)) { + throw exceptionHandler + .handle(new SignatureException("the digest does not match the body of the message"), + SignatureExceptionType.DIFFERENT_DIGESTS); + } + } else { + throw exceptionHandler.handle(new SignatureException("failed to validate the digest"), + SignatureExceptionType.MISSING_DIGEST); + } + LOG.fine("Finished digest verification"); + } + + private MessageDigest getDigestAlgorithm(String digestString) { + try { + return SignatureHeaderUtils.getDigestAlgorithm(digestString); Review comment: We should whitelist the set of acceptable digest algorithms here. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
