Skip to content

NIFI-9785 Improve Login Credentials Writer File Handling #5856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
exceptionfactory wants to merge 1 commit into from
Closed

NIFI-9785 Improve Login Credentials Writer File Handling #5856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 18 additions & 19 deletions ...ava/org/apache/nifi/authentication/single/user/writer/StandardLoginCredentialsWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,20 @@
import javax.xml.stream.events.EndElement;
import javax.xml.stream.events.StartElement;
import javax.xml.stream.events.XMLEvent;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.nio.file.StandardCopyOption;
import java.util.Iterator;

/**
* Standard Login Credentials Writer updates Login Identity Providers Single User definition with Login Credentials
*/
public class StandardLoginCredentialsWriter implements LoginCredentialsWriter {

private static final String PROVIDERS_PREFIX = "login-identity-providers-";

private static final String PROVIDERS_SUFFIX = ".xml";

private static final String CLASS_TAG = "class";

private static final String PROVIDER_TAG = "provider";
Expand All @@ -71,25 +65,30 @@ public StandardLoginCredentialsWriter(final File providersFile) {

@Override
public void writeLoginCredentials(final SingleUserCredentials singleUserCredentials) {
try {
final File updatedProvidersFile = File.createTempFile(PROVIDERS_PREFIX, PROVIDERS_SUFFIX);
writeLoginCredentials(singleUserCredentials, updatedProvidersFile);
Files.move(updatedProvidersFile.toPath(), providersFile.toPath(), StandardCopyOption.REPLACE_EXISTING);
final byte[] providers = readProviders();
try (final InputStream providersInputStream = new ByteArrayInputStream(providers)) {
writeLoginCredentials(singleUserCredentials, providersInputStream);
} catch (final IOException e) {
throw new UncheckedIOException("Writing Login Identity Providers Failed", e);
} catch (final XMLStreamException e) {
throw new RuntimeException("Processing Login Identity Providers Failed", e);
}
}

private void writeLoginCredentials(final SingleUserCredentials singleUserCredentials, final File updatedProvidersFile) throws IOException, XMLStreamException {
try (final OutputStream outputStream = new FileOutputStream(updatedProvidersFile)) {
private byte[] readProviders() {
try {
return Files.readAllBytes(providersFile.toPath());
} catch (final IOException e) {
throw new UncheckedIOException("Reading Login Identity Providers Failed", e);
}
}

private void writeLoginCredentials(final SingleUserCredentials singleUserCredentials, final InputStream inputStream) throws IOException, XMLStreamException {
try (final OutputStream outputStream = new FileOutputStream(providersFile)) {
final XMLEventWriter providersWriter = getProvidersWriter(outputStream);
try (final InputStream inputStream = new FileInputStream(providersFile)) {
final XMLEventReader providersReader = getProvidersReader(inputStream);
updateLoginIdentityProviders(singleUserCredentials, providersReader, providersWriter);
providersReader.close();
}
final XMLEventReader providersReader = getProvidersReader(inputStream);
updateLoginIdentityProviders(singleUserCredentials, providersReader, providersWriter);
providersReader.close();
providersWriter.close();
}
}
Expand Down Expand Up @@ -131,7 +130,7 @@ private void updateLoginIdentityProviders(final SingleUserCredentials singleUser
*
* @param providersReader Providers Reader
* @param providersWriter Providers Writer
* @param propertyValue Property Value to be added
* @param propertyValue Property Value to be added
* @throws XMLStreamException Thrown on XMLEventReader.nextEvent()
*/
private void processProperty(final XMLEventReader providersReader, final XMLEventWriter providersWriter, final String propertyValue) throws XMLStreamException {
Expand Down
17 changes: 17 additions & 0 deletions ...org/apache/nifi/authentication/single/user/writer/StandardLoginCredentialsWriterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,18 @@
import org.apache.nifi.authentication.single.user.SingleUserCredentials;
import org.junit.jupiter.api.Test;

import java.io.File;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.net.URISyntaxException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;
import java.util.UUID;

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class StandardLoginCredentialsWriterTest {
Expand All @@ -38,6 +42,19 @@ public class StandardLoginCredentialsWriterTest {

private static final String PROVIDER_CLASS = SingleUserCredentials.class.getName();

@Test
public void testWriteLoginCredentialsProvidersNotFound() {
final File providersNotFound = new File(UUID.randomUUID().toString());
assertFalse(providersNotFound.exists());

final StandardLoginCredentialsWriter writer = new StandardLoginCredentialsWriter(providersNotFound);

final String username = UUID.randomUUID().toString();
final String password = UUID.randomUUID().toString();
final SingleUserCredentials credentials = new SingleUserCredentials(username, password, PROVIDER_CLASS);
assertThrows(UncheckedIOException.class, () -> writer.writeLoginCredentials(credentials));
}

@Test
public void testWriteLoginCredentialsBlankProviders() throws IOException, URISyntaxException {
final Path sourceProvidersPath = Paths.get(getClass().getResource(BLANK_PROVIDERS).toURI());
Expand Down