forked from benmccann/jenkins-saml-plugin
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[JENKINS-41907] obtain IdP Metadata from URL (#39)
* feature to get the IdP Metadata from an URL * fix tests * AsyncAperiodicWork to update the IdP Metadata * support get ipd metadata from URL * run after start process the XML from the URL and save it without the XML declaration * add XML declaration to IdP metadata * fix test add base acceptan test * exclusion on acceptance-test-harness to be able to package * changes before merge * merge with master * finally the form works and do not have extrange side efects, I hate jelly * form validation methods refactor * validate that XML and URL are not blank * fix test * cleanup * [JENKINS-47880] Navigating to /securityRealm/finishLogin manually shows an odd error * [JENKINS-48030] SAML Azure AD exception * [JENKINS-46063] do not allow blank passwords
- Loading branch information
1 parent
9bbb76e
commit d3c1f8d
Showing
20 changed files
with
832 additions
and
394 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
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
247 changes: 247 additions & 0 deletions
247
src/main/java/org/jenkinsci/plugins/saml/IdpMetadataConfiguration.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,247 @@ | ||
| package org.jenkinsci.plugins.saml; | ||
|
|
||
| import hudson.Extension; | ||
| import hudson.model.AbstractDescribableImpl; | ||
| import hudson.model.Descriptor; | ||
| import hudson.util.FormValidation; | ||
| import org.apache.commons.io.FileUtils; | ||
| import org.apache.commons.io.IOUtils; | ||
| import org.apache.commons.lang.StringUtils; | ||
| import org.kohsuke.stapler.DataBoundConstructor; | ||
| import org.kohsuke.stapler.QueryParameter; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import javax.xml.transform.OutputKeys; | ||
| import javax.xml.transform.Transformer; | ||
| import javax.xml.transform.TransformerConfigurationException; | ||
| import javax.xml.transform.TransformerException; | ||
| import javax.xml.transform.TransformerFactory; | ||
| import javax.xml.transform.dom.DOMSource; | ||
| import javax.xml.transform.stream.StreamResult; | ||
| import javax.xml.transform.stream.StreamSource; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.StringWriter; | ||
| import java.net.MalformedURLException; | ||
| import java.net.URL; | ||
| import java.net.URLConnection; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| import static org.jenkinsci.plugins.saml.SamlSecurityRealm.*; | ||
|
|
||
| /** | ||
| * Class to store the info about how to manage the IdP Metadata. | ||
| */ | ||
| public class IdpMetadataConfiguration extends AbstractDescribableImpl<IdpMetadataConfiguration> { | ||
| private static final Logger LOG = Logger.getLogger(IdpMetadataConfiguration.class.getName()); | ||
|
|
||
| /** | ||
| * IdP Metadata on XML format, it implies there is not automatic updates. | ||
| */ | ||
| private String xml; | ||
|
|
||
| /** | ||
| * URL to update the IdP Metadata from. | ||
| */ | ||
| private String url; | ||
| /** | ||
| * Period in minutes between each IdP Metadata update. | ||
| */ | ||
| private Long period; | ||
|
|
||
| /** | ||
| * Jelly Constructor. | ||
| * @param xml Idp Metadata XML. if xml is null, url and period should not. | ||
| * @param url Url to download the IdP Metadata. | ||
| * @param period Period in minutes between updates of the IdP Metadata. | ||
| */ | ||
| @DataBoundConstructor | ||
| public IdpMetadataConfiguration(String xml, String url, Long period) { | ||
| this.xml = xml; | ||
| this.url = url; | ||
| this.period = period; | ||
| } | ||
|
|
||
| /** | ||
| * Inline Constructor. | ||
| * @param xml IdP Metadata XML. | ||
| */ | ||
| public IdpMetadataConfiguration(@Nonnull String xml) { | ||
| this.xml = xml; | ||
| this.period = 0L; | ||
| } | ||
|
|
||
| /** | ||
| * Idp Metadata downloaded from an Url Constructor. | ||
| * @param url URL to grab the IdP Metadata. | ||
| * @param period Period between updates of the IdP Metadata. | ||
| */ | ||
| public IdpMetadataConfiguration(@Nonnull String url, @Nonnull Long period) { | ||
| this.url = url; | ||
| this.period = period; | ||
| } | ||
|
|
||
| public String getXml() { | ||
| return xml; | ||
| } | ||
|
|
||
| public String getUrl() { | ||
| return url; | ||
| } | ||
|
|
||
| public Long getPeriod() { | ||
| return period; | ||
| } | ||
|
|
||
| /** | ||
| * @return Return the Idp Metadata from the XML file JENKINS_HOME/saml-idp.metadata.xml. | ||
| * @throws IOException in case it can not read the IdP Metadata file. | ||
| */ | ||
| public String getIdpMetadata() throws IOException { | ||
| return FileUtils.readFileToString(new File(SamlSecurityRealm.getIDPMetadataFilePath())); | ||
| } | ||
|
|
||
| /** | ||
| * Creates the IdP Metadata file (saml-idp.metadata.xml) in JENKINS_HOME using the configuration. | ||
| * @throws IOException in case of error writing the file. | ||
| */ | ||
| public void createIdPMetadataFile() throws IOException { | ||
| try { | ||
| if (StringUtils.isNotBlank(xml)) { | ||
| FileUtils.writeStringToFile(new File(SamlSecurityRealm.getIDPMetadataFilePath()), xml); | ||
| } else { | ||
| updateIdPMetadata(); | ||
| } | ||
| } catch (IOException e) { | ||
| throw new IOException("Can not write IdP metadata file in JENKINS_HOME", e); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Gets the IdP Metadata from an URL, then validate it and write it to a file (JENKINS_HOME/saml-idp.metadata.xml). | ||
| * @throws IOException in case of error writing the file or validating the content. | ||
| */ | ||
| public void updateIdPMetadata() throws IOException { | ||
| try { | ||
| URLConnection urlConnection = new URL(url).openConnection(); | ||
| try (InputStream in = urlConnection.getInputStream()) { | ||
| TransformerFactory tf = TransformerFactory.newInstance(); | ||
| Transformer transformer = tf.newTransformer(); | ||
| transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no"); | ||
| transformer.setOutputProperty(OutputKeys.INDENT, "yes"); | ||
| StringWriter writer = new StringWriter(); | ||
| transformer.transform(new StreamSource(in), new StreamResult(writer)); | ||
| String xml = writer.toString(); | ||
| FormValidation validation = new SamlValidateIdPMetadata(xml).get(); | ||
| if (FormValidation.Kind.OK == validation.kind) { | ||
| FileUtils.writeStringToFile(new File(SamlSecurityRealm.getIDPMetadataFilePath()), xml); | ||
| } else { | ||
| throw new IllegalArgumentException(validation.getMessage()); | ||
| } | ||
| } | ||
| } catch (IOException | TransformerException e) { | ||
| throw new IOException("Was not possible to update the IdP Metadata from the URL " + url, e); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public String toString() { | ||
| final StringBuilder sb = new StringBuilder("IdpMetadataConfiguration{"); | ||
| sb.append("xml='").append(xml).append('\''); | ||
| sb.append(", url='").append(url).append('\''); | ||
| sb.append(", period=").append(period); | ||
| sb.append('}'); | ||
| return sb.toString(); | ||
| } | ||
|
|
||
| @Extension | ||
| public static final class DescriptorImpl extends Descriptor<IdpMetadataConfiguration> { | ||
| public DescriptorImpl() { | ||
| super(); | ||
| } | ||
|
|
||
| public DescriptorImpl(Class<? extends IdpMetadataConfiguration> clazz) { | ||
| super(clazz); | ||
| } | ||
|
|
||
| @Override | ||
| public String getDisplayName() { | ||
| return ""; | ||
| } | ||
|
|
||
| public FormValidation doTestIdpMetadata(@QueryParameter("xml") String xml) { | ||
| if (StringUtils.isBlank(xml)) { | ||
| return FormValidation.error(ERROR_IDP_METADATA_EMPTY); | ||
| } | ||
|
|
||
| return new SamlValidateIdPMetadata(xml).get(); | ||
| } | ||
|
|
||
| public FormValidation doCheckPeriod(@QueryParameter("period") String period) { | ||
| if (StringUtils.isEmpty(period)) { | ||
| return FormValidation.error(ERROR_NOT_VALID_NUMBER); | ||
| } | ||
| long i = 0; | ||
| try { | ||
| i = Long.parseLong(period); | ||
| } catch (NumberFormatException e) { | ||
| return FormValidation.error(ERROR_NOT_VALID_NUMBER, e); | ||
| } | ||
|
|
||
| if (i < 0) { | ||
| return FormValidation.error(ERROR_NOT_VALID_NUMBER); | ||
| } | ||
|
|
||
| if (i > Integer.MAX_VALUE) { | ||
| return FormValidation.error(ERROR_NOT_VALID_NUMBER); | ||
| } | ||
|
|
||
| return FormValidation.ok(); | ||
| } | ||
|
|
||
| public FormValidation doCheckXml(@QueryParameter("xml") String xml, @QueryParameter("url") String url) { | ||
| if (StringUtils.isBlank(xml) && StringUtils.isBlank(url)) { | ||
| return FormValidation.error(ERROR_IDP_METADATA_EMPTY); | ||
| } | ||
|
|
||
| return FormValidation.ok(); | ||
| } | ||
|
|
||
| public FormValidation doCheckUrl(@QueryParameter("url") String url) { | ||
| if (StringUtils.isEmpty(url)) { | ||
| return FormValidation.ok(); | ||
| } | ||
| try { | ||
| new URL(url); | ||
| } catch (MalformedURLException e) { | ||
| return FormValidation.error(ERROR_MALFORMED_URL, e); | ||
| } | ||
| return FormValidation.ok(); | ||
| } | ||
|
|
||
| public FormValidation doTestIdpMetadataURL(@QueryParameter("url") String url) { | ||
| URLConnection urlConnection = null; | ||
| try { | ||
| urlConnection = new URL(url).openConnection(); | ||
| } catch (IOException e) { | ||
| LOG.log(Level.SEVERE, e.getMessage(), e); | ||
| return FormValidation.error(NOT_POSSIBLE_TO_GET_THE_METADATA + url); | ||
| } | ||
|
|
||
| try (InputStream in = urlConnection.getInputStream()) { | ||
| String xml = IOUtils.toString(in,StringUtils.defaultIfEmpty(urlConnection.getContentEncoding(),"UTF-8")); | ||
| return new SamlValidateIdPMetadata(xml).get(); | ||
| } catch (MalformedURLException e) { | ||
| return FormValidation.error(ERROR_MALFORMED_URL); | ||
| } catch (IOException e) { | ||
| LOG.log(Level.SEVERE, e.getMessage(), e); | ||
| return FormValidation.error(NOT_POSSIBLE_TO_GET_THE_METADATA + url); | ||
| } | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.