X-PUSH 동작에 대한 설정은 $XPUSH_HOME/conf/xpush_config.xml 파일을 사용하여 설정합니다. 대부분 값은 배포 시의 값을 그대로 사용할 것을 권장드립니다.

Web Push 설정

WEB Client에 대한 Push 설정은 다음과 같습니다.

<service name="WebPublisher" ...>
	...
	<attribute name="ServerBindAddress">0.0.0.0</attribute>
	<attribute name="Port">50000</attribute>
	<attribute name="IsHttps">true</attribute>
	...
</service>

Runtime Push 설정

Runtime Client에 대한 Push 설정은 다음과 같습니다.

<service name="RuntimePublisher" ...>
	...
	<attribute name="ServerBindAddress">0.0.0.0</attribute>
	<attribute name="Port">50001</attribute>
	<attribute name="IsSSL">true</attribute>
	...
</service>

메시지 공급 설정

Message Provider에 대한 세부 설정은 다음과 같습니다.

<service name="Provider" ...>
	...
	<attribute name="ServerBindAddress">0.0.0.0</attribute>
	<attribute name="Port">50002</attribute>
	...
</service>

모니터링 설정

콘솔 모니터링

모니터에 대한 세부 설정은 다음과 같습니다.

<service name="PushMonitor" ...>
	...
	<attribute name="ServerBindAddress">0.0.0.0</attribute>
	<attribute name="Port">50003</attribute>
	...
</service>

JMX

X-PUSH 서버에는 JMX 를 세팅하는 항목이 4개가 있습니다.

이 4개의 항목은 다음과 같습니다.

JMXpassword 를 사용하기 위해서는 2개의 파일이 필요합니다. 이 두개의 파일은 XPUSH_HOME/conf/ 디렉터리에 위치해야 합니다.

이 2개의 파일은 jmxremote.password, jmxremote.access 이며 JAVA_HOME/jre/lib/management/ 폴더에 jmxremote.access, jmxremote.password와 같은 형식입니다.

다음은 JMX 설정 예입니다.

<service name="Publisher">
	...
	<attribute name="IsJMX">ture</attribute>
	<attribute name="IsJMXpassword">true</attribute>
	<attribute name="JMXrmiRegistryPort">50005</attribute>
	<attribute name="JMXrmiServerPort">50006</attribute>
	...
</service>

JMX 항목에서 CPU, Process, Memory, Swap, Network와 같은 System 정보를 확인할 수 있습니다.

<service name="Publisher">
	...
	<attribute name="IsSystemMonitor">true</attribute>
	...
</service>

DB 연결 설정

DBCP Service를 통해 DB 연결을 제어할 수 있습니다.

<service name="DbcpService">    
    <attribute name="username">sa</attribute>
    <attribute name="password"></attribute>
    <attribute name="connectUri">jdbc:h2:tcp://localhost/~/test</attribute>
    <attribute name="jdbcClassName">org.h2.Driver</attribute>
    <attribute name="maxActive">10</attribute>
    <attribute name="maxIdle">0</attribute>
    <attribute name="minIdle">5</attribute>
    <attribute name="maxWait">-1</attribute>
    <attribute name="validationQuery">select 1 from dual</attribute>
    <attribute name="testOnBorrow">true</attribute>
    <attribute name="testOnReturn">false</attribute>
    <attribute name="testWhileIdle">false</attribute>
    <attribute name="timeBetweenEvictionRunsMillis">-1</attribute>
    <attribute name="numTestsPerEvictionRun">3</attribute>
    <attribute name="minEvictableIdleTimeMillis">1800000</attribute>
    <attribute name="UserInfoEncryptorClassName">com.nexacro.xpush.crypto.XPushPBEStringEncryptor</attribute>
    <attribute name="isEncrypted">false</attribute>
    <depends>Log</depends>
</service>

암호화 알고리즘 방식의 변경이 필요하다면? AES 방식 DB 연결 설정

Log 설정

X-PUSH 서버는 파일에 로그를 남기고, 이와 별도로 콘솔에도 로그를 보여줍니다. 파일과 콘솔을 별개로 설정할 수 있습니다.

로그 레벨

4개의 레벨에 따라 로그를 남깁니다. 각 레벨은 우선순위 값(priority)을 가지며 그 의미는 다음과 같습니다.

우선순위값은 로그레벨을 설정할 때 사용되는 값입니다.

콘솔 로그의 레벨을 변경하려면 "Log" 서비스 안의 "ConsoleLogger" 서비스 안의 "PriorityRange" 어트리뷰트의 값을, 파일 로그의 레벨을 변경하려면 "Log"서비스 안의 "FileLogger" 서비스 안의 "PriorityRange" 어트리뷰트의 값을 수정합니다.

배포 시의 기본 설정값은 둘 다 '0:20'으로 되어 있으며, 이것은 우선순위 값 0에서 20까지의 레벨을 출력한다는 의미입니다. 만약 INFO를 로그에서 제외하고 싶다면 '0:10'과 같이 수정합니다.

<service name="Log">
	...
	<depends>
		<service name="ConsoleLogger">
			...
			<attribute name="PriorityRange">0:10</attribute>
			...
		</service>
	</depends>
	...
	<depends>
		<service name="FileLogger">
			...
			<attribute name="PriorityRange">0:40</attribute>
			...
		</service>
	</depends>
</service>

로그 파일 설정

"FileLogWriter" 서비스에서 로그 파일에 관련된 설정을 합니다.

<service name="FileLogWriter">
	<attribute name="LogPath">log</attribute>
	<attribute name="LogFile">xpush.log</attribute>
	<attribute name="Encoding">utf-8</attribute>
	<attribute name="Append">true</attribute>
	<attribute name="MaximumFileSize">100000000</attribute>
	<attribute name="MaxBackupIndex">100</attribute>
	<attribute name="BufferedIO">false</attribute>
</service>

각 어트리뷰트의 의미는 다음과 같습니다.

X-PUSH 상태 로그 파일 설정

현재 X-PUSH의 상태를 모니터링할 수 있는 정보를 파일로 기록합니다.

<service name="MonitorLogWriter">
            <attribute name="IsRecord">false</attribute>
            <attribute name="LogPath">log\status</attribute>
            <attribute name="LogFile">xpush.status</attribute>
            <attribute name="DatePattern">'.'yyyy-MM-dd</attribute>
            <attribute name="Encoding">utf-8</attribute>
            <attribute name="Append">true</attribute>
            <attribute name="RecordingPeriod">5000</attribute>
            <attribute name="PushMonitorServiceName">#PushMonitor</attribute>
</service>

각 어트리뷰트의 의미는 다음과 같습니다.

클러스터링 설정

여러대의 X-PUSH 서버를 하나의 클러스터로 묶어 메시지를 공유할 수 있습니다. 특정 서버로 Provider 메시지를 공급하면, 클러스터로 묶여있는 모든 서버로 Provider 메시지가 공급이 됩니다.

클러스터링을 위해 xpush_config.xml 의 HazelcastService를 설정합니다.

Hazelcast Service에는 다음과 같은 4개의 설정 항목이 있습니다.

다음은 3대의 X-PUSH 서버를 Hazelcast Service로 설정한 예입니다. 포트 번호를 자동증가시키지 않고 50007 포트를 사용하며, TCP/IP를 이용하여 192.168.1.1 주소를 사용하는 다른 X-PUSH서버와 연결하도록 설정했습니다.

X-PUSH #1
ip : 192.168.1.1

<service name=" HazelcastService" ... >
	...
	<attribute name="portAutoIncrement">false</attribute>
	<attribute name="port">50007</attribute>
	<attribute name="joinTcpipEnable">true</attribute>
	<attribute name="joinTcpipMember" type = "java.lang.String[]">
		192.168.1.2:50007,
		192.168.1.3:50007
	</attribute>
</service>

X-PUSH #2
ip : 192.168.1.2

<service name=" HazelcastService" ... >
	...
	<attribute name="portAutoIncrement">false</attribute>
	<attribute name="port">50007</attribute>
	<attribute name="joinTcpipEnable">true</attribute>
	<attribute name="joinTcpipMember" type = "java.lang.String[]">
		192.168.1.1:50007,
		192.168.1.3:50007	</attribute>
</service>

X-PUSH #3
ip : 192.168.1.3

<service name=" HazelcastService" ... >
	...
	<attribute name="portAutoIncrement">false</attribute>
	<attribute name="port">50007</attribute>
	<attribute name="joinTcpipEnable">true</attribute>
	<attribute name="joinTcpipMember" type = "java.lang.String[]">
		192.168.1.1:50007,
		192.168.1.2:50007	</attribute>
</service>

사용자 인증 설정

X-PUSH 서버는 3개의 접속(Client, Provider, Monitor)에 대하여 각각의 인증을 외부의 인증자에게 요청합니다. Authenticator 인터페이스를 구현한 각 인증자를 구현한 후 그 클래스를 설정파일에 설정하여야 인증이 필요할 때 해당 클래스를 로드하여 인증을 요청합니다.

3가지 접속 방법이 있는 이유로 3개의 인증자가 필요합니다.

client 인증

<service name="MiPlatformProtocolReliabilityAuthenticator" ...>
	<attribute name="AuthenticatorClassName">
	com.nexacro.xpush.fw.service.auth.UserPropertiesReliabilityAuthenticator
	</attribute>
</service>

클라이언트 인증의 경우 UserPropertiesReliabilityAuthenticator 클래스로 설정되며 모든 유저의 접속이 허용됩니다.

provider 인증

<service name="SocketProviderProtocolAuthenticator" ..>
		<attribute name="AuthenticatorClassName">
			com.nexacro.xpush.fw.service.auth.UserProfileDummyAuthenticator
		</attribute>
</service>

Provider 인증의 경우 UserProfileDummyAuthenticator 클래스로 설정되며 모든 유저의 접속이 허용됩니다.

monitor 인증

Admin 혹은 Monitor 접속에 대한 인증자는 아래 어트리뷰트 값에서 확인 할 수 있습니다.

"MonitorProtocol" 서비스 > "depends" 엘리멘트 
> "MonitorProtocolAuthenticator" 서비스 > "AuthenticatorClassName" 어트리뷰트 값

<service name="MonitorProtocol">
	...
	<depends>
		<service name="MonitorProtocolAuthenticator">
			<attribute name="AuthenticatorClassName"> 
                com.nexacro.xpush.fw.service.auth.UserPropertiesEncryptAuthenticator
            </attribute>      		
		</service>
	</depends>
	...
</service>

Monitor 인증의 경우 UserPropertiesEncryptAuthenticator 클래스로 설정되며 $XPUSH_HOME/conf/user.properties 파일의 id와 pw를 참조합니다.

UserPropertiesEncryptAuthenticator 클래스는 $XPUSH_HOME/conf/user.properties에 암호화된 password를 입력하여 사용자 인증을 수행할 수 있습니다.

암호화 알고리즘 방식의 변경이 필요하다면? AES 방식 monitor 인증 (user.properties 관련)

모바일 알림 설정

X-PUSH 서버에서는 APNs, FCM 두 가지 플랫폼으로의 모바일 알림 서비스를 제공합니다. 각각의 서비스는 xpush_config.xml에서 설정항목을 수정하여 사용할 수 있습니다. 또한, NotificationFormatter를 사용하여 전달될 notification을 커스터마이징할 수 있습니다.

NotificationBuilder Service

Notification Builder 서비스에서 T_Notification 테이블에 한 번에 저장 및 에러코드 업데이트할 개수를 지정할 수 있습니다.

다음은 Notification Builder Service 설정의 예입니다. 조회된 Device N개를 한번에 1000개씩 Insert 하며, Apns/FCM으로부터 받은 응답이 쌓여 있는 큐에서 1000개씩 가져와 해당하는 컬럼을 100개씩 Update합니다.

<service name="NotificationBuilderServcice" ... >

	<attribute name="insertBatchAtOnceCount">1000</attribute>
	<attribute name="UpdateHandlerBatchAtOnceCount">100</attribute>
	<attribute name="UpdateHandlerProcessingAtOnceCount">1000</attribute>
	<attribute name="NotificationFormatterName">
		com.nexacro.xpush.service.notification.NotificationFormatterPropertiesImpl
	</attribute>
	....

</service>

NotificationAttributeCommon Service

FCM, APNS를 포함한 notification에 대한 공통 속성을 정의하는 서비스입니다.

다음은 NotificationAttributeCommonService에 대한 설정입니다. IsMultiAppWithProjectID를 true로 설정하였으며, message_satete가 0인 메세지에 대해서만 badge를 표시하도록 설정하고 서버 내부 에러 일 때, 재 전송 시도 횟수를 3회로 설정하였습니다.

<service name="NotificationAttributeCommonService" ...>
	<attribute name="IsMultiAppWithProjectID">true</attribute>
	<attribute name="badge">true</attribute>
	<attribute name="IsBadgeOnlyStateZero">true</attribute>
	<attribute name="retries">3</attribute>
</service>

APNs (Apple Push Notification Service)

Apns MultiApp Service

IsMultiAppWithProjectID가 true로 설정되었다면, N개 이상의 모바일 앱에 대한 처리를 수행할 수 있습니다.

ApnsInfo Service 구성하기

ApnsInfo 서비스에서는 1개의 프로젝트에 N개의 앱을 설정할 수 있습니다. 서비스 이름은 사용자가 적절하게 구성할 수 있습니다. 예를 들어 TOBESOFT_1 프로젝트와 TOBESOFT_2 프로젝트에 각각에 포함된 모바일 앱에 대한 정보가 들어 갈 수 있습니다. 어트리뷰트에는 다음과 같은 2개의 설정 항목이 있습니다.

다음은 ApnsInfo Service 설정 예입니다. 서비스는 각 각 APNS_INFO_TOBESOFT_1, APNS_INFO_TOBESOFT_2 이름으로 구성 하고 프로젝트 명과 APNS App 정보를 추가하였습니다.

<service name="APNS_INFO_TOBESOFT_1" code="com.nexacro.xpush.service.notification.InfoApnsWithProjectIDService" instance="singleton" management="false">
	<attribute name="ProjectID">TOBESOFT_1</attribute>
	<attribute name="AppInfo" type ="java.util.HashMap">
		com.nexacro.apns=C:\tmp\apns.p12,12345,PKCS12,false,
		com.nexacro.apns2=C:\tmp\apns2.p12,12345,PKCS12,false,

    </attribute>
</service>

<service name="APNS_INFO_TOBESOFT_2" code="com.nexacro.xpush.service.notification.InfoApnsWithProjectIDService" instance="singleton" management="false">
	<attribute name="ProjectID">TOBESOFT_2</attribute>
	<attribute name="AppInfo" type ="java.util.HashMap">
		com.nexacro.apns3=C:\tmp\apns3.p12,12345,PKCS12,false,
    </attribute>
</service>

Apns Notifier Service

APNs Notifier Service에는 다음과 같은 8개의 설정 항목이 있습니다.

다음은 APNs Notifier Service 설정 예입니다. ApnsInfo 서비스는 2개 구성하였고, 기타 속성에 대한 설정을 지정하였습니다.

<service name="ApnsNotifierService" ... >
	...
	<attribute name="ApnsInfo">
		#APNS_INFO_TOBESOFT_1
		#APNS_INFO_TOBESOFT_2
	</attribute>

	<attribute name="ApnsConnectorName">com.nexacro.xpush.service.notification.connector.XPushApnsConnector</attribute>
	...
	<attribute name="sound">default</attribute>
    <attribute name="feedbackService">true</attribute>
	<attribute name="ApnsHandlerThreadPoolCount">1</attribute>
	<attribute name="failOver">true</attribute>
	...
</service>

FCM (Firebase Colud Messageing)

FCM MultiApp Service

IsMultiAppWithProjectID가 true로 설정되었다면, N개 이상의 FCM 프로젝트에 대한 처리를 수행할 수 있습니다.

FCMInfo Service 구성하기

FCMInfo 서비스에서는 1개의 프로젝트에 N개의 FCM 프로젝트를 설정할 수 있습니다. 서비스 이름은 사용자가 적절하게 구성할 수 있습니다. 예를 들어 TOBESOFT_1 프로젝트와 TOBESOFT_2 프로젝트에 각각에 포함된 FCM 프로젝트 정보가 들어 갈 수 있습니다. 어트리뷰트에는 다음과 같은 2개의 설정 항목이 있습니다.

다음은FcmInfo Service 설정 예입니다. 서비스는 각각 FCM_INFO_TOBESOFT_1, FCM_INFO_TOBESOFT_2 라는 이름으로 구성 하였으며, 프로젝트 명과 FCM 서버 정보를 추가하였습니다.

<service name="FCM_INFO_TOBESOFT_1" code="com.nexacro.xpush.service.notification.InfoFcmWithProjectIDService" instance="singleton" management="false">
		<attribute name="ProjectID">TOBESOFT_1</attribute>
 		<attribute name="SendID">78965651</attribute>					
		<attribute name="ApiKey">ASDGKMXEGE73RSGXE</attribute>
</service>

<service name="FCM_INFO_TOBESOFT_2" code="com.nexacro.xpush.service.notification.InfoFcmWithProjectIDService" instance="singleton" management="false">
		<attribute name="ProjectID">TOBESOFT_2</attribute>
 		<attribute name="SendID">34215651</attribute>					
		<attribute name="ApiKey">GRSDLCDMSPRSC2TK</attribute>
</service>

GCM Notifier Service

X-PUSH 서버에서 FCM으로 Notification 전송을 할 때, GCM Notifier Service를 사용합니다.

GCM Notifier Service에는 다음과 같은 6개의 설정 항목이 있습니다.

다음은 GCM Notifier Service 설정 예입니다. GcmInfo 서비스는 2개 구성하였고, 기타 속성에 대한 설정을 지정하였습니다.

<service name="GcmNotifierService" ... >
	...
	<attribute name="FcmInfo">
		#FCM_INFO_TOBESOFT_1
		#FCM_INFO_TOBESOFT_2
    </attribute>
	<attribute name="GcmConnectorName">com.nexacro.xpush.service.notification.connector.GcmHttpConnector</attribute>

	<attribute name="FailOver">true</attribute>
</service>

스케줄링 설정

<service name=" CronTabScheduleService ">
	...
	<argument type="java.lang.String">
		0 0 1 * *
	</argument> <!-- 매월 1일 0시 0분 메시지 삭제 -->
	...
</service>

수신 완료된 메시지 삭제

<invoke name="add">
   <!-- 매월 1일 0시 0분 메시지 삭제  -->
   <argument type="java.lang.String">0 0 1 * *</argument> 
   <argument type="it.sauronsoftware.cron4j.Task">
      <object code="com.nexacro.xpush.service.schedule.DeleteMessageTask">
         <attribute name="dbcpService">
            <service-ref>#DbcpService</service-ref>
         </attribute>
      </object>             	 			
   </argument>
</invoke>

유효기간 메시지 삭제

<invoke name="add">
   <!-- 매월 매일 0시 0분 만료 메시지 삭제  -->
   <argument type="java.lang.String">0 0 * * *</argument> 
   <argument type="it.sauronsoftware.cron4j.Task">
      <object code="com.nexacro.xpush.service.schedule.DeleteExpiredMessageTask">
         <attribute name="dbcpService">
            <service-ref>#DbcpService</service-ref>
         </attribute>
      </object>             	 			
   </argument>
</invoke>

유효기간 알림 삭제

<invoke name="add">
 <!-- 일요일 0시 0분 만료 알림 삭제  -->
<argument type="java.lang.String">0 0 * * *</argument>
	<argument type="it.sauronsoftware.cron4j.Task">
<object code="com.nexacro.xpush.service.schedule.DeleteExpiredNotificationTask">
			<attribute name="dbcpService">
                   <service-ref>#DbcpService</service-ref>
            </attribute>
     </object>            
</argument>
</invoke>

Apns 피드백서비스 연결 및 응답 받은 디바이스 토큰 업데이트

<invoke name="add">
<!-- 매일 0시 0분 피드백서비스 활성화 및 디바이스토큰 업데이트  -->
<argument type="java.lang.String">0 0 * * *</argument> 
	<argument type="it.sauronsoftware.cron4j.Task">
<object code="com.nexacro.xpush.service.schedule.ApnsFeedbackServiceTask">
		<attribute name="dbcpService">
        	<service-ref>#DbcpService</service-ref>
        </attribute>
        <attribute name="apnsNotifierService">
            <service-ref>#ApnsNotifierService</service-ref>
         </attribute>
      </object>             	 			
</argument>
</invoke>

SSL 인증서 설정

X-PUSH 서버에서는 암호화 통신을 위해서 SSL을 사용합니다.

<service name="CertificateService">

	<attribute name="Path">C:/xpush-2.8.0/conf/cacao.tobesoft.co.kr.jks</attribute>
	<attribute name="Password">1234567890</attribute>
	<attribute name="IsEncrypted">false</attribute>			 

 <attribute name="CertificatesPasswordEncryptorClassName">com.nexacro.xpush.crypto.XPushPBEStringEncryptor</attribute>

</service>

암호화 알고리즘 방식의 변경이 필요하다면? AES 방식 SSL 인증서 설정

암호화 설정

보안에 민감한 정보를 암호화할 수 있도록 기능을 제공합니다.

암호화 가능 3가지

1. SSL 비밀번호 암호화

2. user.properties 의 비밀번호 암호화

3. DB 접속 계정 암호화

run_ssl_encrypt.sh password
run_property_encrypt.sh password
run_dbcp_userinfo_encrypt.sh

암호화 알고리즘 방식의 변경이 필요하다면? 암호화 알고리즘의 변경 설정 및 사용법 (AES)

SSL 인증서 정보 암호화

CertificateService에서는 아래와 같이 설정하고 있는 인증서 정보 중 보안에 민감할 수 있는 정보의 암호화 기능을 제공합니다.
암호화를 할 경우, 아래 항목에서 password 항목을 암호화해야 합니다.

계정 정보의 암복호화에는 위 항목 중 CertificatesPasswordEncryptorClassName에 설정된 클래스를 통해서 이루어집니다.
패키지에서 제공되는 스크립트를 사용하여 암호화된 비밀번호 정보를 얻을 수 있습니다. 이에 따라 isEncrypt 항목과 Password 항목을 수동으로 설정해야 합니다.
X-PUSH 구동 시 isEncrypted 항목이 true인 경우, 비밀번호 정보를 복호화하여 인증서에 설정됩니다.

암호화

SSL 인증서 정보의 암호화에는 X-PUSH 패키지에 포함된 run_ssl_encrypt 스크립트(.sh, .bat)를 사용합니다.
스크립트 파일은 bin/ 디렉토리에 위치합니다.

run_ssl_encrypt.sh password

위와 같이 스크립트를 실행시킬 경우, X-PUSH 서버내에 있는 암호화키로 사용하여 암호화를 하게 됩니다.

run_ssl_encrypt.sh password xpush

위와 같이 스크립트를 실행시킬 경우, xpush라는 문자열을 암호화키로 사용하여 암호화를 하게 됩니다.
스크립트를 실행하면 아래와 같은 암호화 된 값을 얻을 수 있습니다.

<service name="CertificateService">

	<attribute name="Path">C:/xpush-2.6.7/conf/cacao.tobesoft.co.kr.jks</attribute>
	<attribute name="Password">QhJoZx1QQ03Km+u2Sk63tsvu6o3cX9OeP/t3ZImwLtg=</attribute>
	<attribute name="IsEncrypted">true</attribute>			 

 <attribute name="CertificatesPasswordEncryptorClassName">com.nexacro.xpush.crypto.XPushPBEStringEncryptor</attribute>

</service>

복호화

X-PUSH 실행 후 SSL/HTTPS 방식의 클라이언트 연결을 위해, 암호화할 때 사용했던 암호화키를 X-PUSH 실행 시에 인자로 넘겨주어야 합니다. 
X-PUSH는 인자로 넘겨받은 암호화 키로 비밀번호를 복호화하여 인증서를 설정합니다.

startup.sh xpush

사용자 암호화키를 사용하지 않고, X-PUSH 내부적으로 설정된 키를 사용할 경우 인자가 없습니다.

startup.sh

실패시 에러 사항

암호화에 필요한 암호화키가 설정되지 않았을 경우, 비밀번호를 잘못 설정했을 경우 발생합니다.
설정된 키로 복호화 하지 않았거나 비밀번호를 잘못 암호화 하여 X-PUSH를 구동하고, SSL 인증된 클라이언트를 연결한다면 다음과 같은 오류가 발생합니다.

암호화 알고리즘 방식의 변경이 필요하다면? SSL 암호화, user.properties 암호화

user.properties password 암호화

암호화

user.properties 파일의 password 값을 암호화하려면 직접 값을 생성해서 파일에 입력해야 합니다.

run_property_encrypt.sh xpush

스크립트를 통해 생성된 password를 user.properties에 입력합니다.

복호화

xpush 서버 내부에 설정된 UserPropertiesEncryptAuthenticator 클래스에서는 사용자가 설정한 비밀번호를 키로 설정하여 user.properties에 암호화된 비밀번호 값을 복호화하여 일치여부를 확인하고 로그인 성공/여부를 판단합니다.

암호화 알고리즘 방식의 변경이 필요하다면? SSL 암호화, user.properties 암호화

DB 계정 정보 암호화

DbcpService에서는 아래와 같이 설정하고 있는 DB 접속 정보 중 보안에 민감할 수 있는 계정 정보의 암호화 기능을 제공합니다.
암호화를 할 경우, 아래 항목 중 username, password 항목이 암호화됩니다.

<service name="DbcpService">	
	<attribute name="username">xpush</attribute>
	<attribute name="password">xpush</attribute>
	<attribute name="connectUri">jdbc:h2:tcp://localhost/~/test</attribute>
	<attribute name="jdbcClassName">org.h2.Driver</attribute>

	...

	<attribute name="UserInfoEncryptorClassName">com.nexacro.xpush.crypto.XPushPBEStringEncryptor</attribute>
	<attribute name="isEncrypted">false</attribute>

	...

</service>

계정 정보의 암복호화에는 위 항목 중 UserInfoEncryptorClassName에 설정된 클래스를 통해서 이루어집니다.
패키지에서 제공되는 스크립트를 사용하여 암호화를 하면 isEncrypted 항목이 자동으로 true로 설정되며 만약 설정을 변경하거나 기타 이유로 암호화를 하였는데 isEncrypted 항목이 false인 경우, true로 변경해주셔야 합니다.
X-PUSH가 기동 시 isEncrypted 항목이 true인 경우, 계정 정보를 복호화하여 DB에 접속합니다.

암호화

DB 계정정보의 암호화에는 X-PUSH 패키지에 포함된 run_dbcp_userinfo_encrypt 스크립트(.sh, .bat)를 사용합니다.
스크립트 파일은 bin/ 디렉토리에 위치합니다.

run_dbcp_userinfo_encrypt.sh xpush

위와 같이 스크립트를 실행시킬 경우, xpush라는 문자열을 암호화키로 사용하여 암호화를 하게 됩니다.
스크립트를 실행하면 아래와 같이 username, password 항목이 암호화되며, isEncrypted 항목이 true로 변경됩니다.

run_dbcp_userinfo_encrypt.sh

위와 같이 스크립트를 실행시킬 경우, X-PUSH 내부적으로 설정된 암호화키로 사용하여 암호화를 하게 됩니다.
스크립트를 실행하면 아래와 같이 username, password 항목이 암호화되며, isEncrypted 항목이 true로 변경됩니다.

<service name="DbcpService">	
	<attribute name="username">Va3n7cU3aaB/JSqhfQNBBo7UUejPmBjHY//8iLxo80Mv+w1TTDKUv8yPQfpdkRnORrYcBDRugEDi4jfcn6zpmQ==</attribute>
	<attribute name="password">VRibE8jCKPKDFpA+RZ7rLsfau3Uc5JSRfctCg5yZx9czByNzGFOWNOhxgKBcVDRuadP6NsMuJ7zRK0TLKwK1jQ==</attribute>
	<attribute name="connectUri">jdbc:h2:tcp://localhost/~/test</attribute>
	<attribute name="jdbcClassName">org.h2.Driver</attribute>

	...

	<attribute name="UserInfoEncryptorClassName">com.nexacro.xpush.crypto.XPushPBEStringEncryptor</attribute>
	<attribute name="isEncrypted">true</attribute>

	...

</service>

복호화

X-PUSH 실행 시 암호화된 계정정보로 DB에 접속할 수 있도록 하려면 암호화할 때 사용했던 암호화키를 X-PUSH 실행 시에 인자로 넘겨주어야 합니다. 
X-PUSH는 인자로 넘겨받은 암호화키로 계정정보를 복호화하여 DB에 접속하게 됩니다.

startup.sh xpush

암호화키를 인자로 넘겨서 실행 시, 로그레벨이 DEBUG 일 경우에만, isEncrypted 항목값으로 암호화 적용여부를 확인할 수 있습니다.
그외에 복호화된 계정정보를 출력하지 않으며, 정상 케이스일 경우 DB 접속이 정상적으로 이루어졌다는 로그를 확인할 수 있습니다.

[DEBUG] DBCPService Attribute isEncrypted=true
[INFO] Check Database Connection : OK
[INFO] Check All Tables : OK

startup.sh

실패시 오류 로그

암호화에 필요한 암호화키가 설정되지 않았을 경우, 발생합니다.
암호화키를 설정하지 않을 경우, 기본 암호화키로 실행됩니다.

[DEBUG] DBCPService Attribute isEncrypted=true
[ERROR] Password not set for Password Based Encryptor
[ERROR] Fail Get a Database Connection. Check Database.

JDK에 JCE Unlimited Strength Jurisdiction Policy File 파일을 설치하지 않은 상태에서 7자 이상의 암호화키를 사용할 경우 발생합니다.

[DEBUG] DBCPService Attribute isEncrypted=true
[ERROR] Encryption raised an exception. A possible cause is you are using strong encryption algorithms and you have not installed the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files in this Java Virtual Machine
[ERROR] Fail Get a Database Connection. Check Database.

주로 암호화키가 틀렸을 경우, 발생합니다. 상세한 로그 메시지는 보안을 위해서 생략되었습니다.

[DEBUG] DBCPService Attribute isEncrypted=true
[ERROR] Decryption operation failed, ommitting any further information about the cause for security reasons.
[ERROR] Fail Get a Database Connection. Check Database.

암호화 알고리즘 방식의 변경이 필요하다면? DB 암호화

메시지 유효기간 설정

신뢰성 메시지의 유효기간을 서버에서 설정합니다.

<service name=" RepositoryService ">	
	...
	<attribute name="availablePeriod">-1</attribute>				
	<attribute name="maximumAvailablePeriod">-1</attribute>	
	...
</service>

메시지 복구 설정

수신응답 메시지의 처리 과정에서 오류 시 파일로 저장된 메시지 복구서비스 입니다.

<service name=" RecoverService ">
	...
	<attribute name="RecoverPeriod">600000</attribute> <!--10분 간격으로 복구-->
	...
</service>

암호화 알고리즘의 변경 설정 및 사용법 (AES)

특정 환경에서 기존 암호화 알고리즘 (SHA256, 256BITAES 활용) 을 지원하지 않을 때, AES 암호화 알고리즘으로 변경해서 사용하는 방법입니다.

암호화 가능 3가지

1. SSL 비밀번호 암호화

2. user.properties 의 비밀번호 암호화

3. DB 접속 계정 암호화

설정

$XPUSH_HOME/conf/xpush_config.xml 에서 변경할 부분 3가지 (AES 암호화 알고리즘 사용 시)

AES 방식 SSL 인증서 설정

기존 암호화 방식 설명 참고: SSL 인증서 설정

<service name="CertificateService">

	<attribute name="Path">C:/xpush-2.8.0/conf/cacao.tobesoft.co.kr.jks</attribute>
	<attribute name="Password">1234567890</attribute>
	<attribute name="IsEncrypted">false</attribute>			 

 <attribute name="CertificatesPasswordEncryptorClassName">com.nexacro.xpush.crypto.XPushAESStringEncryptor</attribute>

</service>

AES 방식 monitor 인증 (user.properties 관련)

기존 암호화 방식 설명 참고: monitor 인증

<service name="MonitorProtocol">
	...
	<depends>
		<service name="MonitorProtocolAuthenticator">
			<attribute name="AuthenticatorClassName"> 
                com.nexacro.xpush.fw.service.auth.UserPropertiesEncryptAuthenticator_AES
            </attribute>      		
		</service>
	</depends>
	...
</service>

AES 방식 DB 연결 설정

기존 암호화 방식 설명 참고: DB 연결 설정

<service name="DbcpService">    
    <attribute name="username">sa</attribute>
    <attribute name="password"></attribute>
    <attribute name="connectUri">jdbc:h2:tcp://localhost/~/test</attribute>
    <attribute name="jdbcClassName">org.h2.Driver</attribute>
    <attribute name="maxActive">10</attribute>
    <attribute name="maxIdle">0</attribute>
    <attribute name="minIdle">5</attribute>
    <attribute name="maxWait">-1</attribute>
    <attribute name="validationQuery">select 1 from dual</attribute>
    <attribute name="testOnBorrow">true</attribute>
    <attribute name="testOnReturn">false</attribute>
    <attribute name="testWhileIdle">false</attribute>
    <attribute name="timeBetweenEvictionRunsMillis">-1</attribute>
    <attribute name="numTestsPerEvictionRun">3</attribute>
    <attribute name="minEvictableIdleTimeMillis">1800000</attribute>
    <attribute name="UserInfoEncryptorClassName">com.nexacro.xpush.crypto.XPushAESStringEncryptor</attribute>
    <attribute name="isEncrypted">false</attribute>
</service>

사용법

$XPUSH_HOME/bin 에서 사용할 script 2가지 (AES 암호화 알고리즘 사용 시)

run_encrypt_AES.bat/sh
run_dbcp_userinfo_encrypt_AES.bat/sh

SSL 암호화, user.properties 암호화

스크립트 실행 방법

- X-PUSH 에 내재된 암호화키를 이용하여 암호화할 경우

Windows: run_encrypt_AES.bat word (암호화할 문자열)
Linux: ./run_encrypt_AES.sh word

- 사용자가 임의로 지정한 암호화키를 사용할 경우

Windows: run_encrypt_AES.bat word encryptKey (사용자가 임의로 지정한 암호화키)
Linux: ./run_encrypt_AES.sh word encryptKey

xpush_config.xml 설정 방법

- xpush_config.xml 에 수동 반영 필요

기존 암호화 방식 설명 참고: SSL 인증서 정보 암호화, user.properties password 암호화

DB 암호화

스크립트 실행 방법

- X-PUSH 에 내재된 암호화키를 이용하여 암호화할 경우

Windows: run_dbcp_userinfo_encrypt_AES.bat word (암호화할 문자열)
Linux: ./run_dbcp_userinfo_encrypt_AES.sh word

- 사용자가 임의로 지정한 암호화키를 사용할 경우

Windows: run_dbcp_userinfo_encrypt_AES.bat word encryptKey (사용자가 임의로 지정한 암호화키)
Linux: ./run_dbcp_userinfo_encrypt_AES.sh word encryptKey

xpush_config.xml 설정 방법

- xpush_config.xml 에 자동 반영됨

기존 암호화 방식 설명 참고: DB 계정 정보 암호화

SSL 복호화, user.properties 복호화, DB 복호화

- X-PUSH 에 내재된 암호화키를 이용하여 복호화할 경우

Windows: startup.bat 
Linux: ./startup.sh

- 사용자가 임의로 지정한 암호화키를 이용하여 복호화할 경우

Windows: startup.bat encryptKey (사용자가 임의로 지정한 암호화키)
Linux: ./starup.sh encryptKey

암호화키 관련 에러 해결 방법

사용자가 임의로 지정한 암호화키가 16자를 초과하며, JDK8 사용자가 Unlimited JCE Policy 가 설정되어있지 않을 경우, 하단의 에러가 발생할 수 있습니다.

암호화 키 값이 일치하지 않습니다.
java.security.InvalidKeyException: Illegal key size