Skip to content

Restore CredentialsSnapshotTaker for special SSHUserPrivateKey impls #127

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

Merged
jglick merged 5 commits into from
Jun 29, 2022
Merged

Restore CredentialsSnapshotTaker for special SSHUserPrivateKey impls #127

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
16cac8f
Restore SnapshotTaker for SSHUserPrivateKey
jamesrobson-secondmind Jun 13, 2022
da45d19
Refactor snapshot taker
jamesrobson-secondmind Jun 17, 2022
a6aaa7e
Special case snapshots of BasicSSHUserPrivateKey
jamesrobson-secondmind Jun 24, 2022
31bfdf9
Revert gratuitous diff hunks
jglick Jun 24, 2022
2e1ade3
Add defence to the snapshot taker
jamesrobson-secondmind Jun 29, 2022
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
30 changes: 30 additions & 0 deletions src/main/java/com/cloudbees/jenkins/plugins/sshcredentials/impl/BasicSSHUserPrivateKey.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@

import com.cloudbees.jenkins.plugins.sshcredentials.SSHUserPrivateKey;
import com.cloudbees.plugins.credentials.CredentialsScope;
import com.cloudbees.plugins.credentials.CredentialsSnapshotTaker;

import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import hudson.DescriptorExtensionList;
Expand Down Expand Up @@ -531,4 +533,32 @@ private Object readResolve() {
// the critical field allow the permission check to make the XML read to fail completely in case of violation
Items.XSTREAM2.addCriticalField(BasicSSHUserPrivateKey.class, "privateKeySource");
}

@Extension
public static class CredentialsSnapshotTakerImpl extends CredentialsSnapshotTaker<SSHUserPrivateKey> {
/**
* {@inheritDoc}
*/
@Override
public Class<SSHUserPrivateKey> type() {
return SSHUserPrivateKey.class;
}

/**
* {@inheritDoc}
*/
@Override
public SSHUserPrivateKey snapshot(SSHUserPrivateKey credentials) {
if (credentials instanceof BasicSSHUserPrivateKey) {
final PrivateKeySource keySource = ((BasicSSHUserPrivateKey) credentials).getPrivateKeySource();
if (keySource.isSnapshotSource()) {
return credentials;
}
}
final Secret passphrase = credentials.getPassphrase();
return new BasicSSHUserPrivateKey(credentials.getScope(), credentials.getId(), credentials.getUsername(),
new DirectEntryPrivateKeySource(credentials.getPrivateKeys()),
passphrase == null ? null : passphrase.getEncryptedValue(), credentials.getDescription());
}
}
}