[RUBY] Part 2 Using the SmartHR library kiji to run e-Gov (e-Gov public materials)

Introducing the flow and public materials for general software developers to develop software services using the e-Gov external linkage API.

1. 1. Development flow

General software developers, etc. (hereinafter referred to as "developer companies") need to apply for software development to e-Gov (Ministry of Internal Affairs and Communications).

① Apply for software development ② Documents related to application for verification environment use will be sent from e-Gov ③ The developer fills in the necessary items (user ID, etc.) and sends the verification environment use application to e-Gov. ④ e-Gov sends materials related to the verification environment ⑤ The developer develops software services ⑥ The developer applies for the final confirmation test ⑦ The developer submits the final confirmation test result ⑧ Software service becomes available by pass judgment from e-Gov

In ③, the developer describes the following contents in the verification environment use application form.

At ④, e-Gov will send you materials related to the verification environment. Developers need to tightly control this information.

Regarding the verification environment URL, the request URL will be different from the production environment. At this timing, the user ID described in the verification environment usage application form is registered in e-Gov, and the following certificates are managed in association with this user ID.

2. About public materials

You can Download the materials prepared for developers from e-Gov. Here you will find usage guides, terms, application forms, specifications, digital certificates for verification environment testing, etc.

Here, we will introduce the specifications, verification environment test procedures, and digital certificates.

2.1 Specifications

(1) API (Version 1) specifications

It describes the specifications related to the request URI and its parameters for electronic application using API, the send XML specified in the http request body, and the response body (response XML) returned by e-Gov.

(2) Information security requirement specifications

It describes the security requirements that developers must comply with when developing software.

(3) Application data specifications Common data specifications

The data specifications common to all procedures and the individual specifications for each procedure are described. The XML tag structure is defined for configuration management XML, configuration information XML, and application form XML.

(4) Application data specifications and application XML structure definition

The individual specifications for the application data for each procedure are described.

2.2 Verification environment test procedure

It is a public specification about the test procedure that can be used when testing related to the external linkage API in the verification environment.

--In the verification environment, 38 types of standard format and 45 types of individual signature format are prepared for labor and social insurance related procedures for both normal and error systems. --Each procedure defines conditions related to the procedure (signature / non-signature, attached documents, submission destination, withdrawal, etc.), possible processing after arrival, etc. --Each procedure belongs to one of 32 form patterns, and it is necessary to set data items according to the contents of the form pattern.

In the "API test procedure list", you can check the following contents for the test procedure.

――The application form for each procedure is patterned so that it covers the test cases required for testing the API, and appropriate procedure information is set and maintained. --For the procedures for issuing official documents and the procedures for notifying comments, sample official documents and comment contents will be notified respectively. --The file format extensions allowed for attachments are "doc", "xls", "pdf", "docx", "xlsx", and "txt". --For procedures whose first three digits of the procedure identifier are "950", the status after application will be automatically changed.

In "API test procedure list (attached API test procedure status transition list)", you can check the automatic status transition. The following two examples are introduced.

--Of the standard format, the procedure identifier = 950A010002010000 has the procedure name "Notification of change (correction) related to health insurance / welfare annuity insurance business establishment / electronic application", and an official document will be issued. When the software service makes a batch application, it automatically transitions from (reached) → (under review) → (finished review), and when (finished review) is reached, the official document can be obtained. --Of the standard format, the procedure identifier = 950A010700007000 is the procedure name "Health insurance / welfare annuity insurance insured qualification acquisition notification, Seafarer insurance / welfare annuity insurance insured qualification acquisition notification / electronic application" and is an official document. Will not be issued. When the software service makes a batch application, it automatically transitions from (reached) to (under review). Furthermore, when the software service makes a withdrawal request by specifying the arrival number, it automatically transitions from (under review-during withdrawal processing) → (procedure completed-withdrawn).

2.3 Digital certificate

This section describes the SHA-256 version of the digital certificate used in the verification environment.

The digital certificate suffix represents the format of the certificate. ".Pfx" is a PKCS # 12 (PFX) format key and certificate format that allows you to store and protect your server key along with the entire certificate chain. This format is often used in Microsoft products.

Use the openssl command to check the contents of the certificate. If you are prompted for a password along the way, enter "gpkitest".

Openssl execution result

>openssl pkcs12 -info -in e-GovEE01_sha2.pfx
Enter Import Password:(Enter "gpkitest")
MAC Iteration 2000
MAC verified OK
PKCS7 Data
Shrouded Keybag: pbeWithSHA1And3-KeyTripleDES-CBC, Iteration 2000
Bag Attributes
    localKeyID: 01 00 00 00
    friendlyName: le-d39d0281-d8cb-4396-b002-b4366119c8e4
    Microsoft CSP Name: Microsoft Enhanced Cryptographic Provider v1.0
Key Attributes
    X509v3 Key Usage: 10
Enter PEM pass phrase:
Verifying - Enter PEM pass phrase:
-----BEGIN ENCRYPTED PRIVATE KEY-----
MIIFDjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQITLitdILmV8cCAggA
MBQGCCqGSIb3DQMHBAiXSoB8We54iwSCBMiWf80URxShHlnQltb0fsWst7cAZF2D
/FnXM/8RRrMuK561dB5f+7ImMTtJobdOYOEpeO8sqxhGGeEnivFPMhvrsdGKMZul
nCoQBk0ug0iG2vnlQZAP6RPhbo9u4H3ZtTxJeO4DnYdJJj681vxlkEwhQ+Xv7arV
ZkDAmP20E3tKsobuIKNoLDF6HvrsW6k3bSeYcQqjm71BUAZe9DR2JnBNilbnN7gn
NXtsl8B2bGj8/bATsF37elW/zRkm+35vhcV4jLOEJY67ZF9uVAmSgjGXDuEo3pWO
jrX3t5ErsDXXObjw35cVVTvXUZl6s98p2QC3D/hThUf+MBE+pjO3AnNdb0Pjikmf
Fx1VSaeRW1vpf6/oOdwBUGPJuUXyZm1t93/AiYMOG5r9UFLRoFoHKYeCUte+BO2o
N6M2wUSgekzQejrZeT6ATvRpA15yQ6laAFw6LwPRbJ3zykCch2UAPJaspXgUzdfA
9jGzGuq9xIOgeVe+Gi2OdLBk+hAc0qF+zkrwuhswWT3vSSNQ2/mlfl3kI7MPzcvB
82mzC0aPCts8oG0JVL3m/WpnfO6XFnB5GRB10mo7NyiecjHOEPCfsjOcsTr/Bl1N
EPkh4Rt+o315l4UFtIw8nfK8xiw9ag6Lc8n3IUy9+fUWe/MmZxsvKfMyUe8x8RJA
gubv1R8RUqPg+rq6rCydlPE3RlMwro5ooF5sblWANPpNJwyTOr1CEJHTyWzzdMnz
pdbVj0Tz9P3YvR9+KUmv5FPO+Ke/G0KLVbvg14OUfTr5xFEihUrYPOWtRlGlGOyT
le+rGFAzIsRTJvFU6RGsktGTXyzmPBxY2YPuTnDnkdUCLl8UIcXUPMeWRSIh5YC0
zpPgwLlDdy0dnDSIYo5j2yjhYCYcx0MkkZpkn896RcFkK/QnX5L+EvCz6GIZVxAi
yEzD6lFs4Uamm7E/6MbfyoxxbfIOq8BKoufhSbu/QzUlVw/f1+HXjROaTjB2zRuo
GmuWMugdhEMkKl1R4MTpIhoORdQNYGRWcJfbvSZx6gAmTDMoYkt5h05+haNyXY3t
VkLIlHnpRcQR+JgFghyp0j49kmgyKjRZ6XyCgRnUazE9GOalCZLRZuFQEIlgjNRQ
i5f+LI1UNULxD3PJR8A6AMXiasfk94t4qlpH5xc2HVC44Hrk/gX9vfIYBodw43qX
/r0Z2H/27Qte0IRAZ3jzBV46wN2Y0fqKVQNFchIIJleSebd/ka317ICI8gphf+Js
7Y//jUfl03X7oB2GviVHNzvtjJy0AgAlHkltEgswSbWmd3e+lsCtRpnpe4f1qj76
nYTy0AYtvcZwsE7EaCDYGz/KGQVJjorKVgK12N27catPUcDX3NPMhv9YVe1rcVhT
Iku2X6b0c+YmDSGs05m0LUp8HMN/RUAVg+77atjBT72yqABzV2OcZDc9vHCZfYg2
hO/NSfITPB/Jun/gd4VgjH8sO9Eupa/DgZKQ7b858Md6kjK37iKu8cxvG9VfizFj
/msgnKpZmB0lXnvb7hQUgbeOXC0HP1VswZqq1JBzvFICcFo+4KZQquig2SJytR5o
bFxOWp1zXMllQWSunt1aMnmun/B68BU6SiNXNjnTn+gAd+i3avys8X1VLZBFAwKF
6wY=
-----END ENCRYPTED PRIVATE KEY-----
PKCS7 Encrypted data: pbeWithSHA1And40BitRC2-CBC, Iteration 2000
Certificate bag
Bag Attributes
    localKeyID: 01 00 00 00
subject=/C=JP/O=DemoMin1/OU=CA1/CN=Ichiro Madoguchi
issuer=/C=JP/O=DemoMin1/OU=CA1
-----BEGIN CERTIFICATE-----
MIIEizCCA3OgAwIBAgIEWCsMRzANBgkqhkiG9w0BAQsFADAuMQswCQYDVQQGEwJK
UDERMA8GA1UECgwIRGVtb01pbjExDDAKBgNVBAsMA0NBMTAeFw0xOTEwMjUwMTE2
NTZaFw0yNDEwMjQxNDU5NTlaMEkxCzAJBgNVBAYTAkpQMREwDwYDVQQKDAhEZW1v
TWluMTEMMAoGA1UECwwDQ0ExMRkwFwYDVQQDDBBJY2hpcm8gTWFkb2d1Y2hpMIIB
IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsD81VFFmGM26HYdeGrGzbPba
deBzU4WxIE1r6qeZLxjz7DiV42tjo8QFulWZk6hmCeb5j9ChKp+BA/9Yj6usccKH
ZrPQmbcXUZkXRXz9z/7CLxp8b1zAzJakZ0g7o9iU3a3TpyeP6V+GFtkO8YqfthEs
JsYzx82dUi85Bm4l5pnztozPdXRZd2VJpdwzGqtqw6N9PKzMNWux5C0jklkaPeP5
P6NHLfeN51+phkY2xkdJlry629PeKjZAwN0Z8Xu0JdubCvA95UctoZgBoOjpgDtW
ImV3o9hDpwu+1tMlEBhNZIuKOr2G38qRZ9iJUyoK+XhbzyBUu0A2cwCj0MshbwID
AQABo4IBlDCCAZAwDgYDVR0PAQH/BAQDAgbAMBEGCWCGSAGG+EIBAQQEAwIGQDBO
BgNVHRIERzBFpEMwQTELMAkGA1UEBhMCSlAxHjAcBgNVBAoMFeaooeaTrOawkemW
k+iqjeiovOWxgDESMBAGA1UECwwJ77yj77yh77yRMB8GA1UdIAEB/wQVMBMwEQYP
AoM4ho4xCAEBAAKMmyVkMGgGA1UdEQRhMF+kXTBbMQswCQYDVQQGEwJKUDEeMBwG
A1UECgwV5qih5pOs5rCR6ZaT6KqN6Ki85bGAMRIwEAYDVQQLDAnvvKPvvKHvvJEx
GDAWBgNVBAMMD+eqk+WPo+OAgOS4gOmDjjBQBgNVHR8ESTBHMEWgQ6BBpD8wPTEL
MAkGA1UEBhMCSlAxETAPBgNVBAoMCERlbW9NaW4xMQwwCgYDVQQLDANDQTExDTAL
BgNVBAMMBENSTDEwHwYDVR0jBBgwFoAUFNPnlvRSx8XFOnRlLumW95h4I18wHQYD
VR0OBBYEFD6UH9Exye9dEpz9MHJ3sbUDpoZSMA0GCSqGSIb3DQEBCwUAA4IBAQBb
CKyFGsqMv6+HkrY0OK+4v40PJQAa/KbOC3JTKooLfNCNXTiTwtWAl1sGN+Ow8pIp
8Yvj16VcYpi8zO4TmNe8NT+u/e2OvBXwJ9OxOs9UNI2m/mXGcSSJ7eXMR3aVCniD
U7IaQeicquQttLP9IOk9Ao1W+BM35y5bITA/BMO5tzgaimp4G484QtF/XLi40rGh
aZAHGEfvl0abJXPumjajhnGv7SCkjw4+9qdz5Dtp6kl+GVshQgo6ofpEWhVzdhfq
KhNy8dNRL7C/gOTYm+M9SAFk9syL5xKXRyMUGDOheypiJrW/QyOjrxs6cFa5VqaZ
WcRIq8yVPwABCpGG/hjU
-----END CERTIFICATE-----

――The part enclosed by "----- BEGIN ENCRYPTED PRIVATE KEY -----" to "----- END ENCRYPTED PRIVATE KEY -----" is the private key. --The part surrounded by "----- BEGIN CERTIFICATE -----" to "----- END CERTIFICATE -----" is the certificate (public key). --subject means the person to be proved, issuer means the person to prove. --subject = / C = JP / O = DemoMin1 / OU = CA1 / CN = Ichiro Madoguchi, issuer = / C = JP / O = DemoMin1 / OU = CA1, which is a self-signed certificate for testing, so the issuer ( The issuer) and the subject are the same organization.

In e-Gov, the software developer manages three certificates by associating them with the user ID desired when applying for the verification environment. A valid certificate is usually used for testing. In addition, the expired certificate and the revoked certificate will be used in the test to renew the certificate managed by e-Gov.

3. 3. About the final confirmation test

For the final confirmation test, confirm that data transmission / reception between the software service and e-Gov is successful according to the e-Gov specifications. It does not confirm the function of the software service as an application.

The SmartHR library kiji uses RSpec to automate the final confirmation test.