com.sshtools.ssh.components.SshKeyPair Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of j2ssh-maverick Show documentation

Open source SSH2 API

The newest version!

/**
 * Copyright 2003-2016 SSHTOOLS Limited. All Rights Reserved.
 *
 * For product documentation visit https://www.sshtools.com/
 *
 * This file is part of J2SSH Maverick.
 *
 * J2SSH Maverick is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * J2SSH Maverick 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 J2SSH Maverick.  If not, see .
 */
package com.sshtools.ssh.components;

/**
 * Storage class for a public/private key pair.
 * 
 * @author Lee David Painter
 */
public class SshKeyPair {
	SshPrivateKey privatekey;
	SshPublicKey publickey;

	/**
	 * Get the private key.
	 * 
	 * @return SshPrivateKey
	 */
	public SshPrivateKey getPrivateKey() {
		return privatekey;
	}

	/**
	 * Get the public key.
	 * 
	 * @return SshPublicKey
	 */
	public SshPublicKey getPublicKey() {
		return publickey;
	}

	/**
	 * Wraps a public/private key pair into an SshKeyPair instance.
	 * 
	 * @param prv
	 * @param pub
	 * @return SshKeyPair
	 */
	public static SshKeyPair getKeyPair(SshPrivateKey prv, SshPublicKey pub) {
		SshKeyPair pair = new SshKeyPair();
		pair.publickey = pub;
		pair.privatekey = prv;
		return pair;
	}

	/**
	 * Set the private key
	 * 
	 * @param privatekey
	 */
	public void setPrivateKey(SshPrivateKey privatekey) {
		this.privatekey = privatekey;

	}

	/**
	 * Set the public key
	 * 
	 * @param publickey
	 */
	public void setPublicKey(SshPublicKey publickey) {
		this.publickey = publickey;

	}

}