org.snf4j.tls.session.SessionTicket Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snf4j-tls Show documentation
The SNF4J module for TLS protocol
The newest version!
/*
 * -------------------------------- MIT License --------------------------------
 * 
 * Copyright (c) 2023 SNF4J contributors
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * -----------------------------------------------------------------------------
 */
package org.snf4j.tls.session;

import org.snf4j.tls.cipher.CipherSuite;

public class SessionTicket {

	private final CipherSuite cipherSuite;
	
	private final String protocol;
	
	private final byte[] psk;
	
	private final byte[] ticket;
	
	private final long creationTime;

	private final long expirationTime;
	
	private final long ageAdd;
	
	private final long maxEarlyDataSize;
		
	public SessionTicket(CipherSuite cipherSuite, String protocol, byte[] psk, byte[] ticket, long lifetime, long ageAdd, long maxEarlyDataSize, long creationTime) {
		this.cipherSuite = cipherSuite;
		this.protocol = protocol;
		this.psk = psk;
		this.ticket = ticket;
		this.creationTime = creationTime;
		this.ageAdd = ageAdd;
		expirationTime = creationTime + lifetime * 1000;
		this.maxEarlyDataSize = maxEarlyDataSize;
	}

	public SessionTicket(CipherSuite cipherSuite, String protocol, byte[] psk, byte[] ticket, long lifetime, long ageAdd, long maxEarlyDataSize) {
		this(cipherSuite, protocol, psk, ticket, lifetime, ageAdd, maxEarlyDataSize, System.currentTimeMillis());
	}
	
	public CipherSuite getCipherSuite() {
		return cipherSuite;
	}

	public String getProtocol() {
		return protocol;
	}
	
	public byte[] getPsk() {
		return psk;
	}

	public byte[] getTicket() {
		return ticket;
	}

	public long getCreationTime() {
		return creationTime;
	}

	public long getAgeAdd() {
		return ageAdd;
	}

	public boolean isValid(long currentTime) {
		return expirationTime > currentTime;
	}
	
	public boolean isValid() {
		return isValid(System.currentTimeMillis());
	}
	
	public boolean forEarlyData() {
		return maxEarlyDataSize > 0;
	}
	
	/**
	 * Tells if this ticket supports the early data and specified protocol name
	 * (ALPN).
	 * 
	 * @param protocol the name of protocol or {@code null} if the protocol name is
	 *                 not used
	 * @return {@code true} if this ticket supports the early data and specified
	 *         protocol name
	 */
	public boolean forEarlyData(String protocol) {
		if (maxEarlyDataSize > 0) {
			if (protocol == null) {
				return this.protocol == null;
			}
			return protocol.equals(this.protocol);
		}
		return false;
	}
	
	/**
	 * Gets the maximum size of the early data that can be sent when using this
	 * ticket. For tickets not supporting the early data it should return value less
	 * than {@code 1}.
	 * 
	 * @return the maximum early data size
	 */
	public long getMaxEarlyDataSize() {
		return maxEarlyDataSize;
	}
	
}