javax.net.ssl
인터페이스 SSLSession

public interface SSLSession

SSL 에서는, 2 개의 엔티티간에 진행중의 관계가 세션으로 불립니다. 각 SSL 접속에는, 한 번에 1 개의 세션이 포함됩니다만, 그 세션이 엔티티간의 접속에, 동시에, 또는 연속해 몇번이나 사용되는 일이 있습니다. 1 개의 접속으로 사용되는 세션을 다른 세션으로 옮겨놓을 수도 있습니다. 세션의 작성 또는 참가는, SSL 핸드 쉐이크 때에 행해집니다. 세션을 무효로 하려면 , 시큐리티 또는 자원 사용 상황에 관련하는 정책를 사용하는지, 어플리케이션으로부터 명시적으로 invalidate 를 호출합니다. 세션 관리 정책는 일반적으로, 퍼포먼스를 조정할 경우에 사용합니다.

SSL 세션에는, 표준 세션 속성 이외에, 다음의 read 전용 속성이 있습니다.

• 피어 식별 정보」. 세션은, 특정의 클라이언트와 특정의 서버간에 생성된다. 피어 식별 정보는, 세션이 설정될 때 확립된다. 일반적으로은 X. 509 증명서 체인이 사용된다.
• 「암호화 방식군명」. 암호화 방식군은, 특정의 세션의 접속으로 사용되는 암호화 보호의 종류를 나타낸다.
• 「피어 호스트」. 세션내의 모든 접속은, 같은 2 살의 호스트 사이에 확립된다. 접속처의 호스트의 주소를 사용할 수 있다.

세션은, 명시적으로 무효로 합니다. 특정의 종류의 에러가 발생했을 때는, 암묵적으로 무효가 됩니다.

도입된 버젼:

1.4

메소드의 개요

int	getApplicationBufferSize () 이 세션의 사용중에 상정되는 최대 어플리케이션 데이터의 현재의 사이즈를 가져옵니다.
String	getCipherSuite () 이 세션의 모든 접속에 사용되는 SSL 암호화 방식군의 이름을 돌려줍니다.
long	getCreationTime () 이 세션이 작성되었을 때 각을, UTC 1970년 1 월 1 일 0 시부터의 밀리 세컨드 단위로 돌려줍니다.
byte[]	getId () 이 세션에 할당할 수 있었던 식별자를 돌려줍니다.
long	getLastAccessedTime () 이 세션이 세션 레벨의 인프라스트럭쳐(infrastructure)에 의해 마지막에 액세스 되었을 때 각을, UTC 1970년 1 월 1 일 0 시부터의 밀리 세컨드 단위로 돌려줍니다.
Certificate []	getLocalCertificates () 핸드 쉐이크중에 피어에 송신된 증명서를 돌려줍니다.
Principal	getLocalPrincipal () 핸드 쉐이크중에 피어에 송신된 주체를 돌려줍니다.
int	getPacketBufferSize () 이 세션의 사용중에 상정되는 최대 SSL/TLS 패킷의 현재의 사이즈를 가져옵니다.
X509Certificate []	getPeerCertificateChain () 세션을 정의할 경우에 식별된, 피어의 식별 정보를 돌려줍니다.
Certificate []	getPeerCertificates () 세션을 정의할 경우에 설정된, 피어의 식별 정보를 돌려줍니다.
String	getPeerHost () 이 세션의 피어 호스트명을 돌려줍니다.
int	getPeerPort () 이 세션의 피어의 포트 번호를 돌려줍니다.
Principal	getPeerPrincipal () 세션을 정의할 경우에 설정된, 피어의 식별 정보를 돌려줍니다.
String	getProtocol () 이 세션의 모든 접속에 사용되는 프로토콜의 표준명을 돌려줍니다.
SSLSessionContext	getSessionContext () 이 세션이 바인드 되고 있는 문맥을 돌려줍니다.
Object	getValue (String name) 이 세션의 응용 계층 데이터내에서, 지정된 이름에 바인드 되고 있는 객체를 돌려줍니다.
String []	getValueNames () 세션에 바인드 되고 있는 응용 계층 데이터 객체명의 배열을 돌려줍니다.
void	invalidate () 세션을 무효로 합니다.
boolean	isValid () 재개나 참가가 가능한 유효한 세션인가 어떤가를 돌려줍니다.
void	putValue (String name, Object value) 지정된 name 를 사용해, 지정된 value 객체를 이 세션의 응용 계층 데이터에 바인드 합니다.
void	removeValue (String name) 세션의 응용 계층 데이터로, 지정된 이름에 바인드 된 객체를 삭제합니다.

메소드의 상세

getId

byte[] getId()

이 세션에 할당할 수 있었던 식별자를 돌려줍니다.

반환값:

세션 식별자

getSessionContext

SSLSessionContext  getSessionContext()

이 세션이 바인드 되고 있는 문맥을 돌려줍니다.

문맥은, 일부의 환경에서는 취득할 수 없습니다. 그 경우는 null 를 돌려줍니다.

문맥을 취득할 수 있는 환경에 시큐리티 매니저가 인스톨 되고 있는 경우는, 호출할 때 문맥에 대한 액세스권이 필요하게 되는 일이 있습니다. 그 경우, 액세스권이 없을 때는, 시큐리티 예외가 throw 됩니다. Java 환경에서는, 시큐리티 매니저의 checkPermission 메소드를 호출할 때는,SSLPermission("getSSLSessionContext") 액세스권이 필요합니다.

반환값:

이 세션에 사용되고 있는 세션 문맥. 문맥을 취득할 수 없는 경우는 null.

예외:

SecurityException - 호출측 thread에, SSL 세션 문맥을 취득하는데 필요한 액세스권이 없는 경우.

getCreationTime

long getCreationTime()

이 세션이 작성되었을 때 각을, UTC 1970년 1 월 1 일 0 시부터의 밀리 세컨드 단위로 돌려줍니다.

반환값:

이 세션이 작성되었을 때 각

getLastAccessedTime

long getLastAccessedTime()

이 세션이 세션 레벨의 인프라스트럭쳐(infrastructure)에 의해 마지막에 액세스 되었을 때 각을, UTC 1970년 1 월 1 일 0 시부터의 밀리 세컨드 단위로 돌려줍니다.

액세스란, 세션 데이터를 사용해 새로운 접속이 확립되는 것을 가리킵니다. 세션 관련의 값을 취득 또는 설정하는 등, 어플리케이션 레벨의 조작은 이 액세스 시간에 반영되지 않습니다.

이 정보는, 특히 세션 관리 정책로 사용합니다. 예를 들어, 장시간 사용되어 있지 않은 문맥으로 세션 매니저 thread로부터 세션을 해제하거나 세션을 경과시간에 소트 해 태스크를 최적화하거나 합니다.

반환값:

이 세션이 마지막에 액세스 된 시간

invalidate

void invalidate()

세션을 무효로 합니다.

후속의 접속에서는, 이 세션을 사용할 수 없습니다. 다만, 이 세션을 사용하고 있는 기존의 접속은, 접속이 닫을 때까지 계속 사용할 수 있습니다.

관련 항목:

isValid()

isValid

boolean isValid()

재개나 참가가 가능한 유효한 세션인가 어떤가를 돌려줍니다.

반환값:

이 세션에의 참가가 가능한 경우는 true.

도입된 버젼:

1.5

관련 항목:

invalidate()

putValue

void putValue(String  name,
              Object  value)

지정된 name 를 사용해, 지정된 value 객체를 이 세션의 응용 계층 데이터에 바인드 합니다.

같은 name 를 사용하고 있는 기존의 바인딩은 옮겨놓을 수 있습니다. 새로운 (또는 기존의) value 가 SSLSessionBindingListener 인터페이스를 구현하고 있는 경우,value 에 의해 나타내지는 객체에는 적절한 방법으로 통지됩니다.

시큐리티상의 이유로부터, 같은 이름의 값은 복수의 액세스 제어 문맥을 걸쳐 표시할 수 없습니다.

파라미터:

name - 데이터 객체가 바인드 되는 이름. null 에서도 상관하지 않습니다.

value - 바인드 되는 데이터 객체. null 에서도 상관하지 않습니다.

예외:

IllegalArgumentException - 어느 쪽인가의 인수가 null 의 경우.

getValue

Object  getValue(String  name)

이 세션의 응용 계층 데이터내에서, 지정된 이름에 바인드 되고 있는 객체를 돌려줍니다. 바인딩이 존재하지 않는 경우는 null 를 돌려줍니다.

시큐리티상의 이유로부터, 같은 이름의 값은 복수의 액세스 제어 문맥을 걸쳐 표시할 수 없습니다.

파라미터:

name - 검색하는 바인딩의 이름.

반환값:

지정된 이름에 바인드 된 값. 바인딩이 존재하지 않는 경우는 null

예외:

IllegalArgumentException - 인수가 null 의 경우

removeValue

void removeValue(String  name)

세션의 응용 계층 데이터로, 지정된 이름에 바인드 된 객체를 삭제합니다. 지정된 이름에 바인드 된 객체가 존재하지 않는 경우는, 적용되지 않습니다. 바인드 된 기존의 객체가 SessionBindingListener 인터페이스를 구현하고 있는 경우는, 그 인터페이스에 적절한 방법으로 통지됩니다.

시큐리티상의 이유로부터, 같은 이름의 값은 복수의 액세스 제어 문맥을 걸쳐 표시할 수 없습니다.

파라미터:

name - 삭제하는 객체의 이름. 복수의 액세스 제어 문맥을 걸쳐 표시할 수 있다

예외:

IllegalArgumentException - 인수가 null 의 경우

getValueNames

String [] getValueNames()

세션에 바인드 되고 있는 응용 계층 데이터 객체명의 배열을 돌려줍니다.

시큐리티상의 이유로부터, 같은 이름의 값은 복수의 액세스 제어 문맥을 걸쳐 표시할 수 없습니다.

반환값:

이 세션에 바인드 되고 있는 객체명의, null (빈 상태(empty)의 경우도 있다)가 아닌 배열.

getPeerCertificates

Certificate [] getPeerCertificates()
                                  throws SSLPeerUnverifiedException 

세션을 정의할 경우에 설정된, 피어의 식별 정보를 돌려줍니다.

주:이 메소드를 사용할 수 있는 것은, 증명서 베이스의 암호화 방식군을 사용하고 있는 경우만입니다. Kerberos 등의 증명서 베이스가 아닌 암호화 방식군에게 이 메소드를 사용하면(자), SSLPeerUnverifiedException 가 throw 됩니다.

반환값:

피어 증명서의 배열. 피어 자신의 증명서, 증명서 발행국의 순서에 줄지어 있다.

예외:

SSLPeerUnverifiedException - 피어의 식별 정보를 확인할 수 없었던 경우

관련 항목:

getPeerPrincipal()

getLocalCertificates

Certificate [] getLocalCertificates()

핸드 쉐이크중에 피어에 송신된 증명서를 돌려줍니다.

주:이 메소드가 도움이 되는 것은, 증명서 베이스의 암호화 방식군을 사용하고 있는 경우만입니다.

핸드 쉐이크를 실시할 때 복수의 증명서를 사용할 수 있는 경우는, 최적인 증명서 체인이 선택되어 피어에 송신됩니다. 호출측은, 이 메소드를 사용해, 실제로 사용된 증명서 체인을 파악할 수가 있습니다.

반환값:

증명서의 배열. 로컬 증명서, 증명서 발행국의 순서에 줄지어 있다. 증명서가 송신되지 않았던 경우는, null 가 반환된다.

관련 항목:

getLocalPrincipal()

getPeerCertificateChain

X509Certificate [] getPeerCertificateChain()
                                          throws SSLPeerUnverifiedException 

세션을 정의할 경우에 식별된, 피어의 식별 정보를 돌려줍니다.

주:이 메소드를 사용할 수 있는 것은, 증명서 베이스의 암호화 방식군을 사용하고 있는 경우만입니다. Kerberos 등의 증명서 베이스가 아닌 암호화 방식군에게 이 메소드를 사용하면(자), SSLPeerUnverifiedException 가 throw 됩니다.

주:이 메소드는, 이전의 릴리스와의 호환성을 확보하기 위해서 짜넣어지고 있습니다. 새로운 어플리케이션에서는,getPeerCertificates() 를 사용해 주세요.

반환값:

피어의 X. 509 증명서의 배열. 피어 자신의 증명서, 증명서 발행국의 순서로 나란해지고 있다. 증명서의 형식은, 원의 JSSE 증명서 X509Certificate 형식이다.

예외:

SSLPeerUnverifiedException - 피어의 식별 정보를 확인할 수 없었던 경우

관련 항목:

getPeerPrincipal()

getPeerPrincipal

Principal  getPeerPrincipal()
                           throws SSLPeerUnverifiedException 

세션을 정의할 경우에 설정된, 피어의 식별 정보를 돌려줍니다.

반환값:

피어의 주체. X509 베이스의 암호화 방식군의 경우는 엔드엔티티 증명서의 X500Principal 를 돌려주어, Kerberos 암호화 방식군의 경우는 KerberosPrincipal 를 돌려준다.

예외:

SSLPeerUnverifiedException - 피어의 식별 정보를 확인할 수 없었던 경우

도입된 버젼:

1.5

관련 항목:

getPeerCertificates() , getLocalPrincipal()

getLocalPrincipal

Principal  getLocalPrincipal()

핸드 쉐이크중에 피어에 송신된 주체를 돌려줍니다.

반환값:

피어에 송신된 주체. X509 베이스의 암호화 방식군의 경우는 엔드엔티티 증명서의 X500Principal 를 돌려주어, Kerberos 암호화 방식군의 경우는 KerberosPrincipal 를 돌려준다. 주체가 송신되지 않았던 경우는 null 를 돌려준다.

도입된 버젼:

1.5

관련 항목:

getLocalCertificates() , getPeerPrincipal()

getCipherSuite

String  getCipherSuite()

이 세션의 모든 접속에 사용되는 SSL 암호화 방식군의 이름을 돌려줍니다.

SSL 암호화 방식군은, 사용되는 암호의 종류나 인증 방법의 설정 등, 접속시에 송신되는 데이터에 적용되는 보호의 레벨을 결정합니다.

반환값:

세션의 암호화 방식군의 이름

getProtocol

String  getProtocol()

이 세션의 모든 접속에 사용되는 프로토콜의 표준명을 돌려줍니다.

이 프로토콜에는, 접속으로 사용되는 프로토콜을 정의합니다.

반환값:

이 세션의 모든 접속에 사용되는 프로토콜의 표준명.

getPeerHost

String  getPeerHost()

이 세션의 피어 호스트명을 돌려줍니다.

서버의 경우는, 클라이언트의 호스트명이 됩니다. 클라이언트의 경우는, 서버의 호스트명이 됩니다. 이 이름은, 완전 지정의 호스트명이나 실제의 호스트명은 아니고, 피어 호스트의 네트워크 주소의 캐릭터 라인 인코딩입니다. 완전 지정의 호스트명이나 실제의 호스트명이 필요한 경우는, 이 메소드로부터 반환된 값에 근거해 네임 서비스를 사용하면 해결할 수 있습니다.

이 값은 인증되어 있지 않기 때문에, 실제로 사용할 수 없습니다. 주로,SSLSession 의 캐쉬 방법에 관한 힌트로서 사용됩니다.

반환값:

피어 호스트의 호스트명. 정보가 없는 경우는 null.

getPeerPort

int getPeerPort()

이 세션의 피어의 포트 번호를 돌려줍니다.

서버의 경우는, 클라이언트의 포트 번호가 됩니다. 클라이언트의 경우는, 서버의 포트 번호가 됩니다.

이 값은 인증되어 있지 않기 때문에, 실제로 사용할 수 없습니다. 주로,SSLSession 의 캐쉬 방법에 관한 힌트로서 사용됩니다.

반환값:

피어 호스트의 포트 번호. 정보가 없는 경우는 -1.

도입된 버젼:

1.5

getPacketBufferSize

int getPacketBufferSize()

이 세션의 사용중에 상정되는 최대 SSL/TLS 패킷의 현재의 사이즈를 가져옵니다.

이 세션을 사용하고 있는 SSLEngine 는, 이 메소드로부터 반환된 값이하로, 임의의 사이즈의 SSL/TLS 패킷을 생성할 수 있습니다. wrap 나 unwrap 의 실행시에 용량 부족의 문제를 막기 위해서(때문에),SSLEngine 의 네트워크버퍼-의 사이즈는 모두 이 값이상으로 해 주세요.

반환값:

현재 상정되는 네트워크 패킷의 최대 사이즈

도입된 버젼:

1.5

관련 항목:

SSLEngine.wrap(ByteBuffer, ByteBuffer) , SSLEngine.unwrap(ByteBuffer, ByteBuffer)

getApplicationBufferSize

int getApplicationBufferSize()

이 세션의 사용중에 상정되는 최대 어플리케이션 데이터의 현재의 사이즈를 가져옵니다.

SSLEngine 의 어플리케이션 데이터 버퍼에는, 착신하는 어플리케이션 데이터 패킷에 포함되어 있는 어플리케이션 데이터를 보관 유지하기 위해서 충분한 사이즈가 필요합니다. 일반적으로, 송신 어플리케이션 데이터 버퍼는, 어떠한 사이즈에서도 괜찮습니다.

반환값:

현재 상정되는 어플리케이션 패킷의 최대 사이즈

도입된 버젼:

1.5

관련 항목:

SSLEngine.wrap(ByteBuffer, ByteBuffer) , SSLEngine.unwrap(ByteBuffer, ByteBuffer)