Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
251 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
156 changes: 156 additions & 0 deletions
156
peppol-commons/src/main/java/com/helger/peppol/url/EsensURLProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| /** | ||
| * Copyright (C) 2015-2016 Philip Helger (www.helger.com) | ||
| * philip[at]helger[dot]com | ||
| * | ||
| * Version: MPL 1.1/EUPL 1.1 | ||
| * | ||
| * The contents of this file are subject to the Mozilla Public License Version | ||
| * 1.1 (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.mozilla.org/MPL/ | ||
| * | ||
| * Software distributed under the License is distributed on an "AS IS" basis, | ||
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License | ||
| * for the specific language governing rights and limitations under the | ||
| * License. | ||
| * | ||
| * The Original Code is Copyright The PEPPOL project (http://www.peppol.eu) | ||
| * | ||
| * Alternatively, the contents of this file may be used under the | ||
| * terms of the EUPL, Version 1.1 or - as soon they will be approved | ||
| * by the European Commission - subsequent versions of the EUPL | ||
| * (the "Licence"); You may not use this work except in compliance | ||
| * with the Licence. | ||
| * You may obtain a copy of the Licence at: | ||
| * http://joinup.ec.europa.eu/software/page/eupl/licence-eupl | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the Licence is distributed on an "AS IS" basis, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the Licence for the specific language governing permissions and | ||
| * limitations under the Licence. | ||
| * | ||
| * If you wish to allow use of your version of this file only | ||
| * under the terms of the EUPL License and not to allow others to use | ||
| * your version of this file under the MPL, indicate your decision by | ||
| * deleting the provisions above and replace them with the notice and | ||
| * other provisions required by the EUPL License. If you do not delete | ||
| * the provisions above, a recipient may use your version of this file | ||
| * under either the MPL or the EUPL License. | ||
| */ | ||
| package com.helger.peppol.url; | ||
|
|
||
| import java.nio.charset.Charset; | ||
| import java.util.Locale; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import javax.annotation.Nullable; | ||
| import javax.annotation.concurrent.Immutable; | ||
|
|
||
| import com.helger.commons.ValueEnforcer; | ||
| import com.helger.commons.charset.CCharset; | ||
| import com.helger.commons.charset.CharsetManager; | ||
| import com.helger.commons.codec.Base32Codec; | ||
| import com.helger.commons.string.StringHelper; | ||
| import com.helger.peppol.identifier.generic.participant.IParticipantIdentifier; | ||
| import com.helger.security.messagedigest.EMessageDigestAlgorithm; | ||
| import com.helger.security.messagedigest.MessageDigestValue; | ||
|
|
||
| /** | ||
| * The default implementation of {@link IPeppolURLProvider} suitable for the | ||
| * E-SENS network. See e.g. http://wiki.ds.unipi.gr/display/ESENS/PR+-+BDXL<br> | ||
| * Layout: | ||
| * <code>strip-trailing(base32(sha256(lowercase(ID-VALUE))),"=")+"."+ID-SCHEME+"."+SML-ZONE-NAME</code> | ||
| * | ||
| * @author Philip Helger | ||
| */ | ||
| @Immutable | ||
| public class EsensURLProvider implements IPeppolURLProvider | ||
| { | ||
| public static final IPeppolURLProvider INSTANCE = new EsensURLProvider (); | ||
| public static final Charset URL_CHARSET = CCharset.CHARSET_UTF_8_OBJ; | ||
| public static final Locale URL_LOCALE = Locale.US; | ||
|
|
||
| private boolean m_bLowercaseValueBeforeHashing = true; | ||
|
|
||
| /** | ||
| * Default constructor. | ||
| */ | ||
| public EsensURLProvider () | ||
| {} | ||
|
|
||
| public boolean isLowercaseValueBeforeHashing () | ||
| { | ||
| return m_bLowercaseValueBeforeHashing; | ||
| } | ||
|
|
||
| public void setLowercaseValueBeforeHashing (final boolean bLowercaseValueBeforeHashing) | ||
| { | ||
| m_bLowercaseValueBeforeHashing = bLowercaseValueBeforeHashing; | ||
| } | ||
|
|
||
| /** | ||
| * Get the Base32 encoded, SHA-256 hash-string-representation of the passed | ||
| * value using the {@link #URL_CHARSET} encoding. | ||
| * | ||
| * @param sValueToHash | ||
| * The value to be hashed. May not be <code>null</code>. | ||
| * @return The non-<code>null</code> String containing the hash value. | ||
| */ | ||
| @Nonnull | ||
| public static String getHashValueStringRepresentation (@Nonnull final String sValueToHash) | ||
| { | ||
| final byte [] aMessageDigest = MessageDigestValue.create (CharsetManager.getAsBytes (sValueToHash, URL_CHARSET), | ||
| EMessageDigestAlgorithm.SHA_256) | ||
| .getAllDigestBytes (); | ||
| return new Base32Codec ().setAddPaddding (false).getEncodedAsString (aMessageDigest, | ||
| CCharset.CHARSET_ISO_8859_1_OBJ); | ||
| } | ||
|
|
||
| @Nonnull | ||
| public String getDNSNameOfParticipant (@Nonnull final IParticipantIdentifier aParticipantIdentifier, | ||
| @Nullable final String sSMLZoneName) | ||
| { | ||
| ValueEnforcer.notNull (aParticipantIdentifier, "ParticipantIdentifier"); | ||
|
|
||
| // Ensure the DNS zone name ends with a dot! | ||
| if (StringHelper.hasText (sSMLZoneName) && !StringHelper.endsWith (sSMLZoneName, '.')) | ||
| throw new IllegalArgumentException ("if an SML zone name is specified, it must end with a dot (.). Value is: " + | ||
| sSMLZoneName); | ||
|
|
||
| final StringBuilder ret = new StringBuilder (); | ||
|
|
||
| // Get the identifier value | ||
| // Important: create hash from lowercase string! | ||
| String sIdentifierValue = aParticipantIdentifier.getValue (); | ||
| if (m_bLowercaseValueBeforeHashing) | ||
| sIdentifierValue = sIdentifierValue.toLowerCase (URL_LOCALE); | ||
| ret.append (getHashValueStringRepresentation (sIdentifierValue)).append ('.'); | ||
|
|
||
| // append the identifier scheme | ||
| if (aParticipantIdentifier.hasScheme ()) | ||
| { | ||
| // Check identifier scheme (must be lowercase for the URL later on!) | ||
| String sIdentifierScheme = aParticipantIdentifier.getScheme (); | ||
| if (m_bLowercaseValueBeforeHashing) | ||
| sIdentifierScheme = sIdentifierScheme.toLowerCase (URL_LOCALE); | ||
| ret.append (sIdentifierScheme).append ('.'); | ||
| } | ||
|
|
||
| // append the SML DNS zone name (if available) | ||
| if (StringHelper.hasText (sSMLZoneName)) | ||
| { | ||
| // If it is present, it always ends with a dot | ||
| ret.append (sSMLZoneName); | ||
| } | ||
|
|
||
| // in some cases it gives a problem later when trying to retrieve the | ||
| // participant's metadata ex: | ||
| // http://B-51538b9890f1999ca08302c65f544719.iso6523-actorid-upis.sml.peppolcentral.org./iso6523-actorid-upis%3A%3A9917%3A550403315099 | ||
| // That's why we cut of the dot here | ||
| ret.deleteCharAt (ret.length () - 1); | ||
|
|
||
| // We're fine and done | ||
| return ret.toString (); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
89 changes: 89 additions & 0 deletions
89
peppol-commons/src/test/java/com/helger/peppol/url/EsensURLProviderTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /** | ||
| * Copyright (C) 2015-2016 Philip Helger (www.helger.com) | ||
| * philip[at]helger[dot]com | ||
| * | ||
| * Version: MPL 1.1/EUPL 1.1 | ||
| * | ||
| * The contents of this file are subject to the Mozilla Public License Version | ||
| * 1.1 (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.mozilla.org/MPL/ | ||
| * | ||
| * Software distributed under the License is distributed on an "AS IS" basis, | ||
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License | ||
| * for the specific language governing rights and limitations under the | ||
| * License. | ||
| * | ||
| * The Original Code is Copyright The PEPPOL project (http://www.peppol.eu) | ||
| * | ||
| * Alternatively, the contents of this file may be used under the | ||
| * terms of the EUPL, Version 1.1 or - as soon they will be approved | ||
| * by the European Commission - subsequent versions of the EUPL | ||
| * (the "Licence"); You may not use this work except in compliance | ||
| * with the Licence. | ||
| * You may obtain a copy of the Licence at: | ||
| * http://joinup.ec.europa.eu/software/page/eupl/licence-eupl | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the Licence is distributed on an "AS IS" basis, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the Licence for the specific language governing permissions and | ||
| * limitations under the Licence. | ||
| * | ||
| * If you wish to allow use of your version of this file only | ||
| * under the terms of the EUPL License and not to allow others to use | ||
| * your version of this file under the MPL, indicate your decision by | ||
| * deleting the provisions above and replace them with the notice and | ||
| * other provisions required by the EUPL License. If you do not delete | ||
| * the provisions above, a recipient may use your version of this file | ||
| * under either the MPL or the EUPL License. | ||
| */ | ||
| package com.helger.peppol.url; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
|
|
||
| import org.junit.Test; | ||
|
|
||
| import com.helger.peppol.identifier.generic.participant.SimpleParticipantIdentifier; | ||
| import com.helger.peppol.sml.ESML; | ||
|
|
||
| /** | ||
| * Test class for class {@link EsensURLProvider}. | ||
| * | ||
| * @author Philip Helger | ||
| */ | ||
| public final class EsensURLProviderTest | ||
| { | ||
| @Test | ||
| public void testDefault () | ||
| { | ||
| final EsensURLProvider aURLProvider = new EsensURLProvider (); | ||
| assertEquals ("4444WYPIXHSTJGGABKB7QMG63KJNR7IFMXRALGPORDXI6ZF64HUA.edelivery.tech.ec.europa.eu", | ||
| aURLProvider.getDNSNameOfParticipant (new SimpleParticipantIdentifier (null, | ||
| "urn:oasis:names:tc:ebcore:partyid-type:iso6523:0060:1234567890128"), | ||
| ESML.DIGIT_PRODUCTION)); | ||
| assertEquals ("XJ4BNP4PAHH6UQKBIDPF3LRCEOYAGYNDSYLXVHFUCD7WD4QACWWQ.edelivery.tech.ec.europa.eu", | ||
| aURLProvider.getDNSNameOfParticipant (new SimpleParticipantIdentifier (null, "abc"), | ||
| ESML.DIGIT_PRODUCTION)); | ||
| assertEquals ("XJ4BNP4PAHH6UQKBIDPF3LRCEOYAGYNDSYLXVHFUCD7WD4QACWWQ.edelivery.tech.ec.europa.eu", | ||
| aURLProvider.getDNSNameOfParticipant (new SimpleParticipantIdentifier (null, "ABC"), | ||
| ESML.DIGIT_PRODUCTION)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testNoLowercase () | ||
| { | ||
| final EsensURLProvider aURLProvider = new EsensURLProvider (); | ||
| aURLProvider.setLowercaseValueBeforeHashing (false); | ||
| assertEquals ("4444WYPIXHSTJGGABKB7QMG63KJNR7IFMXRALGPORDXI6ZF64HUA.edelivery.tech.ec.europa.eu", | ||
| aURLProvider.getDNSNameOfParticipant (new SimpleParticipantIdentifier (null, | ||
| "urn:oasis:names:tc:ebcore:partyid-type:iso6523:0060:1234567890128"), | ||
| ESML.DIGIT_PRODUCTION)); | ||
| assertEquals ("XJ4BNP4PAHH6UQKBIDPF3LRCEOYAGYNDSYLXVHFUCD7WD4QACWWQ.edelivery.tech.ec.europa.eu", | ||
| aURLProvider.getDNSNameOfParticipant (new SimpleParticipantIdentifier (null, "abc"), | ||
| ESML.DIGIT_PRODUCTION)); | ||
| assertEquals ("WXKAIXB7IZX2SH7CZRVL46JDFINFPTPRAT32E3TRNYFB4J4J354A.edelivery.tech.ec.europa.eu", | ||
| aURLProvider.getDNSNameOfParticipant (new SimpleParticipantIdentifier (null, "ABC"), | ||
| ESML.DIGIT_PRODUCTION)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters