Cleanup header includes (#392)

The main issue addressed by this PR are circular dependencies in header files. Many of them include umbrella headers (<soter/soter.h>, <themis/themis.h>) which creates a circular dependency in other headers included from umbrella headers. This prevents individual headers from being compiled and analyzed separately by the tools. It also introduces hidden dependency on the inclusion order. To resolve issue avoid using umbrella headers in library code: include specific headers where necessary. Umbrella headers should be used only for the user code (and tests). While we're here, do some cosmetic improvement as well: - unify include guard style to be <PROJECT>_<HEADER>_H everywhere - sort included headers alphabetically - group headers in the meaningful groups - use proper relative paths in headers - consistently use quotes "soter/soter_rsa_key.h" for internal inclusions - consistently use angle brackets <soter/soter.h> for public inclusions These changes are inspired and rationalized by Google C++ Style Guide.
cossacklabs · Feb 28, 2019 · e0f71df · e0f71df
1 parent 7ab2c94
commit e0f71df
Show file tree

Hide file tree

Showing 102 changed files with 395 additions and 415 deletions.
diff --git a/jni/themis_keygen.c b/jni/themis_keygen.c
@@ -16,7 +16,7 @@
 
 #include <jni.h>
 #include <themis/themis_error.h>
-#include <themis/secure_message.h>
+#include <themis/secure_keygen.h>
 
 /* Should be same as in AsymmetricKey.java */
 #define KEYTYPE_EC 0

diff --git a/src/soter/boringssl/soter_asym_cipher.c b/src/soter/boringssl/soter_asym_cipher.c
@@ -14,14 +14,15 @@
 * limitations under the License.
 */
 
-#include <soter/soter.h>
-#include <soter/soter_rsa_key.h>
-#include "soter_engine.h"
+#include "soter/soter_asym_cipher.h"
+
 #include <openssl/evp.h>
 #include <openssl/rsa.h>
 
-#define OAEP_HASH_SIZE 20
+#include "soter/soter_rsa_key.h"
+#include "soter/boringssl/soter_engine.h"
 
+#define OAEP_HASH_SIZE 20
 
 #ifndef SOTER_RSA_KEY_LENGTH
 #define SOTER_RSA_KEY_LENGTH 2048
@@ -317,4 +318,4 @@ soter_status_t soter_asym_cipher_destroy(soter_asym_cipher_t* asym_cipher)
 	{
 		return status;
 	}
-}
+}
diff --git a/src/soter/boringssl/soter_asym_ka.c b/src/soter/boringssl/soter_asym_ka.c
@@ -14,11 +14,13 @@
 * limitations under the License.
 */
 
-#include <soter/soter_error.h>
-#include "soter_engine.h"
-#include <soter/soter_ec_key.h>
+#include "soter/soter_asym_ka.h"
+
 #include <openssl/ec.h>
 
+#include "soter/soter_ec_key.h"
+#include "soter/boringssl/soter_engine.h"
+
 static int soter_alg_to_curve_nid(soter_asym_ka_alg_t alg)
 {
 	switch (alg)

diff --git a/src/soter/boringssl/soter_ec_key.c b/src/soter/boringssl/soter_ec_key.c
@@ -14,14 +14,13 @@
 * limitations under the License.
 */
 
-#include <soter/soter_error.h>
-#include <soter/soter_ec_key.h>
+#include "soter/soter_ec_key.h"
+
+#include <string.h>
 
-#include <openssl/evp.h>
 #include <openssl/bn.h>
 #include <openssl/ec.h>
-
-#include <string.h>
+#include <openssl/evp.h>
 
 static bool is_curve_supported(int curve)
 {

diff --git a/src/soter/boringssl/soter_ecdsa_common.c b/src/soter/boringssl/soter_ecdsa_common.c
@@ -14,11 +14,13 @@
 * limitations under the License.
 */
 
-#include <soter/soter.h>
-#include <soter/soter_ec_key.h>
-#include "soter_engine.h"
-#include <openssl/evp.h>
+#include "soter/boringssl/soter_ecdsa_common.h"
+
 #include <openssl/ec.h>
+#include <openssl/evp.h>
+
+#include "soter/soter_ec_key.h"
+#include "soter/boringssl/soter_engine.h"
 
 soter_status_t soter_ec_gen_key(EVP_PKEY_CTX *pkey_ctx)
 {

diff --git a/src/soter/boringssl/soter_ecdsa_common.h b/src/soter/boringssl/soter_ecdsa_common.h
@@ -14,16 +14,15 @@
 * limitations under the License.
 */
 
-#ifndef SOTER_EC_COMMON_H
-#define SOTER_EC_COMMON_H
+#ifndef SOTER_BORINGSSL_ECDSA_COMMON_H
+#define SOTER_BORINGSSL_ECDSA_COMMON_H
 
-#include <soter/soter.h>
-#include <soter/soter_ec_key.h>
-#include "soter_engine.h"
+#include "soter/soter_ec_key.h"
+#include "soter/soter_error.h"
+#include "soter/boringssl/soter_engine.h"
 
 soter_status_t soter_ec_gen_key(EVP_PKEY_CTX *pkey_ctx);
 soter_status_t soter_ec_import_key(EVP_PKEY *pkey, const void* key, const size_t key_length);
 soter_status_t soter_ec_export_key(soter_sign_ctx_t* ctx, void* key, size_t* key_length, bool isprivate);
 
-#endif
-
+#endif /* SOTER_BORINGSSL_ECDSA_COMMON_H */
diff --git a/src/soter/boringssl/soter_engine.h b/src/soter/boringssl/soter_engine.h
@@ -14,12 +14,15 @@
 * limitations under the License.
 */
 
-#ifndef SOTER_ENGINE_H
-#define SOTER_ENGINE_H
+#ifndef SOTER_BORINGSSL_ENGINE_H
+#define SOTER_BORINGSSL_ENGINE_H
+
+#include <stdint.h>
 
-#include <soter/soter.h>
 #include <openssl/evp.h>
 
+#include "soter/soter_asym_sign.h"
+
 struct soter_hash_ctx_type
 {
   EVP_MD_CTX evp_md_ctx;
@@ -51,4 +54,4 @@ struct soter_sign_ctx_type{
   soter_sign_alg_t alg;
 };
 
-#endif /* SOTER_ENGINE_H */
+#endif /* SOTER_BORINGSSL_ENGINE_H */
diff --git a/src/soter/boringssl/soter_hash.c b/src/soter/boringssl/soter_hash.c
@@ -14,10 +14,11 @@
 * limitations under the License.
 */
 
-#include "soter/soter.h"
-#include "soter_engine.h"
+#include "soter/soter_hash.h"
+
 #include <openssl/evp.h>
 
+#include "soter/boringssl/soter_engine.h"
 
 static const EVP_MD* soter_algo_to_evp_md(soter_hash_algo_t algo)
 {

diff --git a/src/soter/boringssl/soter_rand.c b/src/soter/boringssl/soter_rand.c
@@ -14,7 +14,8 @@
 * limitations under the License.
 */
 
-#include "soter/soter.h"
+#include "soter/soter_rand.h"
+
 #include <openssl/rand.h>
 
 soter_status_t soter_rand(uint8_t* buffer, size_t length)

diff --git a/src/soter/boringssl/soter_rsa_common.c b/src/soter/boringssl/soter_rsa_common.c
@@ -14,12 +14,11 @@
 * limitations under the License.
 */
 
-#include <soter/soter.h>
-#include <soter/soter_rsa_key.h>
-#include "soter_engine.h"
+#include "soter/boringssl/soter_rsa_common.h"
+
+#include <openssl/bn.h>
 #include <openssl/evp.h>
 #include <openssl/rsa.h>
-#include <openssl/bn.h>
 
 #ifndef SOTER_RSA_KEY_LENGTH
 #define SOTER_RSA_KEY_LENGTH 2048
@@ -113,4 +112,3 @@ soter_status_t soter_rsa_export_key(soter_sign_ctx_t* ctx, void* key, size_t* ke
       return soter_engine_specific_to_rsa_pub_key((const soter_engine_specific_rsa_key_t *)pkey, (soter_container_hdr_t *)key, key_length);
     }  
 }
-
diff --git a/src/soter/boringssl/soter_rsa_common.h b/src/soter/boringssl/soter_rsa_common.h
@@ -14,17 +14,16 @@
 * limitations under the License.
 */
 
-#ifndef SOTER_RSA_COMMON_H
-#define SOTER_RSA_COMMON_H
+#ifndef SOTER_BORINGSSL_RSA_COMMON_H
+#define SOTER_BORINGSSL_RSA_COMMON_H
 
-#include <soter/soter.h>
-#include <soter/soter_rsa_key.h>
-#include "soter_engine.h"
+#include "soter/soter_error.h"
+#include "soter/soter_rsa_key.h"
+#include "soter/boringssl/soter_engine.h"
 
 unsigned rsa_key_length(const int size);
 soter_status_t soter_rsa_gen_key(EVP_PKEY_CTX *pkey_ctx, const unsigned key_length);
 soter_status_t soter_rsa_import_key(EVP_PKEY *pkey, const void* key, const size_t key_length);
 soter_status_t soter_rsa_export_key(soter_sign_ctx_t* ctx, void* key, size_t* key_length, bool isprivate);
 
-#endif
-
+#endif /* SOTER_BORINGSSL_RSA_COMMON_H */
diff --git a/src/soter/boringssl/soter_rsa_key.c b/src/soter/boringssl/soter_rsa_key.c
@@ -14,13 +14,13 @@
 * limitations under the License.
 */
 
-#include <soter/soter_error.h>
-#include <soter/soter_rsa_key.h>
+#include "soter/soter_rsa_key.h"
+
+#include <string.h>
 
 #include <openssl/bn.h>
 #include <openssl/evp.h>
 #include <openssl/rsa.h>
-#include <string.h>
 
 static size_t rsa_pub_key_size(int mod_size)
 {

diff --git a/src/soter/boringssl/soter_rsa_key_pair_gen.c b/src/soter/boringssl/soter_rsa_key_pair_gen.c
@@ -14,16 +14,15 @@
 * limitations under the License.
 */
 
-#include <soter/soter_error.h>
-#include "soter_engine.h"
-#include "soter_rsa_common.h"
-#include <soter/soter_rsa_key_pair_gen.h>
+#include "soter/soter_rsa_key_pair_gen.h"
+
+#include <string.h>
 
 #include <openssl/evp.h>
 #include <openssl/rsa.h>
 
-#include <string.h>
-
+#include "soter/boringssl/soter_engine.h"
+#include "soter/boringssl/soter_rsa_common.h"
 
 soter_rsa_key_pair_gen_t* soter_rsa_key_pair_gen_create(const unsigned key_length){
     SOTER_CHECK_PARAM_(rsa_key_length(key_length)>0);

diff --git a/src/soter/boringssl/soter_sign_ecdsa.c b/src/soter/boringssl/soter_sign_ecdsa.c
@@ -14,15 +14,15 @@
 * limitations under the License.
 */
 
-#include <soter/soter_sign_ecdsa.h>
-#include <soter/soter.h>
-#include <soter/soter_ec_key.h>
-#include "soter_engine.h"
-#include "soter_ecdsa_common.h"
-#include <openssl/evp.h>
+#include "soter/soter_sign_ecdsa.h"
+
 #include <openssl/ecdsa.h>
 #include <openssl/err.h>
+#include <openssl/evp.h>
 
+#include "soter/soter_ec_key.h"
+#include "soter/boringssl/soter_ecdsa_common.h"
+#include "soter/boringssl/soter_engine.h"
 
 soter_status_t soter_sign_init_ecdsa_none_pkcs8(soter_sign_ctx_t* ctx, const void* private_key, const size_t private_key_length, const void* public_key, const size_t public_key_length)
 {

diff --git a/src/soter/boringssl/soter_sign_rsa.c b/src/soter/boringssl/soter_sign_rsa.c
@@ -14,14 +14,14 @@
 * limitations under the License.
 */
 
-#include <soter/soter_sign_rsa.h>
-#include <soter/soter.h>
-#include <soter/soter_rsa_key.h>
-#include "soter_engine.h"
-#include "soter_rsa_common.h"
+#include "soter/soter_sign_rsa.h"
+
 #include <openssl/evp.h>
 #include <openssl/rsa.h>
 
+#include "soter/soter_rsa_key.h"
+#include "soter/boringssl/soter_engine.h"
+#include "soter/boringssl/soter_rsa_common.h"
 
 soter_status_t soter_sign_init_rsa_pss_pkcs8(soter_sign_ctx_t* ctx, const void* private_key, const size_t private_key_length, const void* public_key, const size_t public_key_length)
 {
@@ -127,4 +127,4 @@ soter_status_t soter_sign_cleanup_rsa_pss_pkcs8(soter_sign_ctx_t* ctx)
     ctx->md_ctx=NULL;
   }
   return SOTER_SUCCESS;
-}
+}
diff --git a/src/soter/boringssl/soter_sym.c b/src/soter/boringssl/soter_sym.c
@@ -14,11 +14,14 @@
 * limitations under the License.
 */
 
+#include "soter/soter_sym.h"
+
 #include <string.h>
-#include "soter/soter.h"
-#include "soter_engine.h"
-#include <openssl/err.h>
+
 #include <openssl/cipher.h>
+#include <openssl/err.h>
+
+#include "soter/boringssl/soter_engine.h"
 
 #define SOTER_SYM_MAX_KEY_LENGTH 128
 #define SOTER_SYM_MAX_IV_LENGTH 16

diff --git a/src/soter/boringssl/soter_verify_ecdsa.c b/src/soter/boringssl/soter_verify_ecdsa.c
@@ -14,13 +14,14 @@
 * limitations under the License.
 */
 
-#include <soter/soter_sign_ecdsa.h>
-#include <soter/soter.h>
-#include <soter/soter_ec_key.h>
-#include "soter_engine.h"
-#include "soter_ecdsa_common.h"
-#include <openssl/evp.h>
+#include "soter/soter_sign_ecdsa.h"
+
 #include <openssl/ecdsa.h>
+#include <openssl/evp.h>
+
+#include "soter/soter_ec_key.h"
+#include "soter/boringssl/soter_ecdsa_common.h"
+#include "soter/boringssl/soter_engine.h"
 
 soter_status_t soter_verify_init_ecdsa_none_pkcs8(soter_sign_ctx_t* ctx, const void* private_key, const size_t private_key_length, const void* public_key, const size_t public_key_length)
 {

diff --git a/src/soter/boringssl/soter_verify_rsa.c b/src/soter/boringssl/soter_verify_rsa.c
@@ -14,14 +14,15 @@
 * limitations under the License.
 */
 
-#include <soter/soter_sign_rsa.h>
-#include <soter/soter.h>
-#include <soter/soter_rsa_key.h>
-#include "soter_engine.h"
-#include "soter_rsa_common.h"
+#include "soter/soter_sign_rsa.h"
+
 #include <openssl/evp.h>
 #include <openssl/rsa.h>
 
+#include "soter/soter_rsa_key.h"
+#include "soter/boringssl/soter_engine.h"
+#include "soter/boringssl/soter_rsa_common.h"
+
 soter_status_t soter_verify_init_rsa_pss_pkcs8(soter_sign_ctx_t* ctx, const void* private_key, const size_t private_key_length, const void* public_key, const size_t public_key_length)
 {
   /* pkey_ctx init */

diff --git a/src/soter/openssl/soter_asym_cipher.c b/src/soter/openssl/soter_asym_cipher.c
@@ -14,12 +14,14 @@
 * limitations under the License.
 */
 
-#include <soter/soter.h>
-#include <soter/soter_rsa_key.h>
-#include "soter_engine.h"
+#include "soter/soter_asym_cipher.h"
+
 #include <openssl/evp.h>
 #include <openssl/rsa.h>
 
+#include "soter/soter_rsa_key.h"
+#include "soter/openssl/soter_engine.h"
+
 /* We use only SHA1 for now */
 #define OAEP_HASH_SIZE 20
 

diff --git a/src/soter/openssl/soter_asym_ka.c b/src/soter/openssl/soter_asym_ka.c
@@ -14,11 +14,13 @@
 * limitations under the License.
 */
 
-#include <soter/soter_error.h>
-#include "soter_engine.h"
-#include <soter/soter_ec_key.h>
+#include "soter/soter_asym_ka.h"
+
 #include <openssl/ec.h>
 
+#include "soter/soter_ec_key.h"
+#include "soter/openssl/soter_engine.h"
+
 static int soter_alg_to_curve_nid(soter_asym_ka_alg_t alg)
 {
 	switch (alg)