Skip to content
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

Add export/update FileCredentials support #220

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add export/update FileCredentials support #220

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
825c7e1
Add FileCredentials support
mvanini Dec 30, 2022
5922c24
missing import and toString in marshal
mvanini Jun 5, 2023
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
23 changes: 21 additions & 2 deletions credentials-migration/export-credentials-folder-level.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@ import com.thoughtworks.xstream.io.HierarchicalStreamReader
import com.thoughtworks.xstream.io.HierarchicalStreamWriter
import com.trilead.ssh2.crypto.Base64
import hudson.util.Secret
import com.cloudbees.plugins.credentials.SecretBytes
import hudson.util.XStream2
import jenkins.model.Jenkins
import java.nio.charset.StandardCharsets

def instance = Jenkins.get()
def credentials = []
Expand Down Expand Up @@ -61,14 +63,31 @@ def converter = new Converter() {
@Override
boolean canConvert(Class type) { type == Secret.class }
}
// This converter ensure that the output XML contains plain-text for secretBytes (FileCredentials)
def converterSecretBytes = new Converter() {
@Override
void marshal(Object object, HierarchicalStreamWriter writer, MarshallingContext context) {
writer.value = Base64.encode(new String(object.getPlainData(), StandardCharsets.UTF_8).bytes);
}

@Override
Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
return SecretBytes.fromBytes(new String(Base64.decode(reader.getValue().toCharArray())).getBytes(StandardCharsets.UTF_8));
}

@Override
boolean canConvert(Class type) { type == SecretBytes.class }
}

def stream = new XStream2()
stream.registerConverter(converter)
stream.registerConverter(converterSecretBytes)

// Marshal the list of credentials into XML
def encoded = []

def xml = Base64.encode(stream.toXML(domainsFromFolders).bytes)
encoded.add("\"${xml}\"")
//println stream.toXML(domainsFromFolders); return ""; //For debug purpose
def xml = Base64.encode(stream.toXML(domainsFromFolders).bytes)
encoded.add("\"${xml}\"")

println encoded.toString()
18 changes: 18 additions & 0 deletions credentials-migration/export-credentials-system-level.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ import com.thoughtworks.xstream.io.HierarchicalStreamReader
import com.thoughtworks.xstream.io.HierarchicalStreamWriter
import com.trilead.ssh2.crypto.Base64
import hudson.util.Secret
import com.cloudbees.plugins.credentials.SecretBytes
import hudson.util.XStream2
import jenkins.model.Jenkins
import java.nio.charset.StandardCharsets

def instance = Jenkins.get()
def credentials = []
Expand Down Expand Up @@ -48,9 +50,25 @@ def converter = new Converter() {
@Override
boolean canConvert(Class type) { type == Secret.class }
}
// This converter ensure that the output XML contains plain-text for secretBytes (FileCredentials)
def converterSecretBytes = new Converter() {
@Override
void marshal(Object object, HierarchicalStreamWriter writer, MarshallingContext context) {
writer.value = Base64.encode(new String(object.getPlainData(), StandardCharsets.UTF_8).bytes);
}

@Override
Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
return SecretBytes.fromBytes(new String(Base64.decode(reader.getValue().toCharArray())).getBytes(StandardCharsets.UTF_8));
}

@Override
boolean canConvert(Class type) { type == SecretBytes.class }
}

def stream = new XStream2()
stream.registerConverter(converter)
stream.registerConverter(converterSecretBytes)

// Marshal the list of credentials into XML
def encoded = []
Expand Down
24 changes: 19 additions & 5 deletions credentials-migration/update-credentials-folder-level.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@ import com.thoughtworks.xstream.io.HierarchicalStreamReader
import com.thoughtworks.xstream.io.HierarchicalStreamWriter
import com.trilead.ssh2.crypto.Base64
import hudson.util.Secret
import hudson.util.XStream2
import jenkins.model.Jenkins
import com.cloudbees.plugins.credentials.domains.DomainCredentials
import com.trilead.ssh2.crypto.Base64
import com.cloudbees.plugins.credentials.SecretBytes
import hudson.util.XStream2
import jenkins.model.Jenkins
import com.cloudbees.plugins.credentials.Credentials
import java.nio.charset.StandardCharsets

// Paste the encoded message from the script on the source Jenkins
def encoded=[]
Expand All @@ -34,10 +32,26 @@ if (!encoded) {

HashMap<String, List<DomainCredentials>> credentialsList;

// This converter ensure that the output XML contains plain-text for secretBytes (FileCredentials)
def converterSecretBytes = new Converter() {
@Override
void marshal(Object object, HierarchicalStreamWriter writer, MarshallingContext context) { null }

@Override
Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
return SecretBytes.fromBytes(new String(Base64.decode(reader.getValue().toCharArray())).getBytes(StandardCharsets.UTF_8));
}

@Override
boolean canConvert(Class type) { type == SecretBytes.class }
}

// The message is decoded and unmarshaled
for (slice in encoded) {
def decoded = new String(Base64.decode(slice.chars))
domainsFromFolders = new XStream2().fromXML(decoded) as HashMap<String, List<DomainCredentials>> ;
def stream = new XStream2()
stream.registerConverter(converterSecretBytes)
domainsFromFolders = stream.fromXML(decoded) as HashMap<String, List<DomainCredentials>> ;
}

def instance = Jenkins.get()
Expand Down
25 changes: 24 additions & 1 deletion credentials-migration/update-credentials-system-level.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@ Description: Decode from export-credentials-root-level.groovy script, all the cr

import com.cloudbees.plugins.credentials.SystemCredentialsProvider
import com.cloudbees.plugins.credentials.domains.DomainCredentials
import com.thoughtworks.xstream.converters.Converter
import com.thoughtworks.xstream.converters.MarshallingContext
import com.thoughtworks.xstream.converters.UnmarshallingContext
import com.trilead.ssh2.crypto.Base64
import hudson.util.XStream2
import com.cloudbees.plugins.credentials.SecretBytes
import jenkins.model.Jenkins
import java.nio.charset.StandardCharsets

// Paste the encoded message from the script on the source Jenkins
def encoded = []
Expand All @@ -19,10 +24,28 @@ if (!encoded) {
return
}

// This converter ensure that the output XML contains plain-text for secretBytes (FileCredentials)
def converterSecretBytes = new Converter() {
@Override
void marshal(Object object, HierarchicalStreamWriter writer, MarshallingContext context) {
writer.value = Base64.encode(new String(object.getPlainData(), StandardCharsets.UTF_8).bytes);
}

@Override
Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
return SecretBytes.fromBytes(new String(Base64.decode(reader.getValue().toCharArray())).getBytes(StandardCharsets.UTF_8));
}

@Override
boolean canConvert(Class type) { type == SecretBytes.class }
}

// The message is decoded and unmarshaled
for (slice in encoded) {
def decoded = new String(Base64.decode(slice.chars))
def list = new XStream2().fromXML(decoded) as List<DomainCredentials>
def stream = new XStream2()
stream.registerConverter(converterSecretBytes)
def list = stream.fromXML(decoded) as List<DomainCredentials>
// Put all the domains from the list into system credentials
def store = Jenkins.get().getExtensionList(SystemCredentialsProvider.class).first().getStore()
def domainName
Expand Down