search

google / certificate-transparency

Auditing for TLS certificates.
https://certificate.transparency.dev
Apache License 2.0
869 stars 283 forks source link

Python installation instructions ambiguity #1411

Open ricketybridge opened 7 years ago

ricketybridge commented 7 years ago

The instructions for the python installation are ambiguous to me in multiple ways:

  1. Do we have to compile/install the entire main certificate transparency stuff in order for the python stuff to install correctly even if we're only interested in scanning other people's logs rather than maintaining our own log?

  2. Which "parent python/ directory" is instruction 3 of the python README referring to? "3. Run 'make' in the parent python/ directory to generate the Python versions of CT protocol buffers." This instruction immediately follows the instruction to install the protoc compiler, which has its own python directory. Is instruction 3 referring to the python directory within the certificate-transparency repo? I would assume so because the protoc python folder doesn't even have a makefile.

  3. Following the instructions as I've understood them (without installing the overarching certificate transparency program via gclient and whatnot and taking "parent python/ directory" to mean the python directory within certificate-transparency), I'm getting this error:

/certificate-transparency/python/../../install/include: warning: directory does not exist.

I don't see any folders called "install" or "include" in either protoc or certificate-transparency.

Silberschleier commented 6 years ago

To solve your third problem, I had to edit the INSTALL_DIR variable in the Makefile to match with the include directory of my protobuf installation.

I had to search way to long to find this solution, so I agree that there is definitely some need for better documentation.

ricketybridge commented 6 years ago

Thanks so much, @Silberschleier. Because I had put the google directory in the protobuf include directory in /usr/local/include, it appears that -I$(INSTALL_DIR)/include was redundant. I just deleted it and it appears to have compiled correctly--or at least I'm not getting that warning (or any other warnings).

However, this is clearly still an issue in the code.