MasterTO.java

/*
 * Syncany, www.syncany.org
 * Copyright (C) 2011-2016 Philipp C. Heckel <philipp.heckel@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.syncany.config.to;

import java.io.File;

import org.simpleframework.xml.Element;
import org.simpleframework.xml.Root;
import org.simpleframework.xml.core.Commit;
import org.simpleframework.xml.core.Complete;
import org.simpleframework.xml.core.Persist;
import org.simpleframework.xml.core.Persister;
import org.syncany.config.ConfigException;
import org.syncany.util.StringUtil;

/**
 * The master transfer object is used to create and load the master file
 * from/to XML. The master file only contains the salt for the master key.
 *
 * <p>The master file is stored locally and on the remote storage. The salt
 * is used to create the master key from a password.
 *
 * <p>It uses the Simple framework for XML serialization, and its corresponding
 * annotation-based configuration.
 *
 * @see <a href="http://simple.sourceforge.net/">Simple framework</a>
 * @author Philipp C. Heckel (philipp.heckel@gmail.com)
 */
@Root(name = "master", strict = false)
public class MasterTO {
	@Element(name = "salt", required = false)
	private String saltEncoded;
	private byte[] salt;

	public MasterTO() {
		// Required default constructor
	}

	public MasterTO(byte[] salt) {
		this.salt = salt;
	}

	public byte[] getSalt() {
		return salt;
	}

	public void setSalt(byte[] salt) {
		this.salt = salt;
	}

	public void save(File file) throws ConfigException {
		try {
			new Persister().write(this, file);
		}
		catch (Exception e) {
			throw new ConfigException("Cannot write masterTO to file " + file, e);
		}
	}

	@Persist
	public void prepare() {
		saltEncoded = (salt != null) ? StringUtil.toHex(salt) : null;
	}

	@Complete
	public void release() {
		saltEncoded = null;
	}

	@Commit
	public void commit() {
		salt = (saltEncoded != null) ? StringUtil.fromHex(saltEncoded) : null;
	}
}