mirror of https://github.com/briansmith/webpki
168 lines
4.5 KiB
Python
168 lines
4.5 KiB
Python
#!/usr/bin/python
|
|
# Copyright (c) 2015 The Chromium Authors. All rights reserved.
|
|
# Use of this source code is governed by a BSD-style license that can be
|
|
# found in the LICENSE file.
|
|
|
|
"""This script is called without any arguments to re-format all of the *.pem
|
|
files in the script's parent directory.
|
|
|
|
The main formatting change is to run "openssl asn1parse" for each of the PEM
|
|
block sections (except for DATA), and add that output to the comment.
|
|
|
|
Refer to the README file for more information.
|
|
"""
|
|
|
|
import glob
|
|
import os
|
|
import re
|
|
import base64
|
|
import subprocess
|
|
|
|
|
|
def Transform(file_data):
|
|
"""Returns a transformed (formatted) version of file_data"""
|
|
|
|
result = ''
|
|
|
|
# Get the file's description (all the text before the first PEM block)
|
|
file_description = GetTextUntilNextPemBlock(file_data)
|
|
|
|
result += file_description + '\n'
|
|
|
|
for block in GetPemBlocks(file_data):
|
|
result += '\n\n\n'
|
|
|
|
result += MakePemBlockString(block.name, block.data)
|
|
|
|
# If there was a user comment (non-script-generated comment) associated
|
|
# with the block, output it immediately after the block.
|
|
user_comment = GetUserComment(block.comment)
|
|
if user_comment:
|
|
result += '\n' + user_comment + '\n'
|
|
|
|
# For every block except for DATA, try to pretty print the parsed ASN.1.
|
|
# DATA blocks likely would be DER in practice, but for the purposes of
|
|
# these tests seeing its structure doesn't clarify
|
|
# anything and is just a distraction.
|
|
if block.name != 'DATA':
|
|
generated_comment = GenerateCommentForBlock(block.name, block.data)
|
|
result += '\n' + generated_comment + '\n'
|
|
|
|
return result
|
|
|
|
|
|
def GenerateCommentForBlock(block_name, block_data):
|
|
"""Returns a string describing the ASN.1 structure of block_data"""
|
|
|
|
p = subprocess.Popen(['openssl', 'asn1parse', '-i', '-inform', 'DER'],
|
|
stdout=subprocess.PIPE, stdin=subprocess.PIPE,
|
|
stderr=subprocess.PIPE)
|
|
stdout_data, stderr_data = p.communicate(input=block_data)
|
|
generated_comment = '$ openssl asn1parse -i < [%s]\n%s' % (block_name,
|
|
stdout_data)
|
|
return generated_comment.strip('\n')
|
|
|
|
|
|
def GetTextUntilNextPemBlock(text):
|
|
return text.split('-----BEGIN ', 1)[0].strip('\n')
|
|
|
|
|
|
def GetUserComment(comment):
|
|
"""Removes any script-generated lines (everything after the $ openssl line)"""
|
|
|
|
# Consider everything after "$ openssl" to be a generated comment.
|
|
comment = comment.split('$ openssl asn1parse -i', 1)[0].strip('\n')
|
|
if IsEntirelyWhiteSpace(comment):
|
|
comment = ''
|
|
return comment
|
|
|
|
|
|
def MakePemBlockString(name, data):
|
|
return ('-----BEGIN %s-----\n'
|
|
'%s'
|
|
'-----END %s-----\n') % (name, EncodeDataForPem(data), name)
|
|
|
|
|
|
def GetPemFilePaths():
|
|
"""Returns an iterable for all the paths to the PEM test files"""
|
|
|
|
base_dir = os.path.dirname(os.path.realpath(__file__))
|
|
return glob.iglob(os.path.join(base_dir, '*.pem'))
|
|
|
|
|
|
def ReadFileToString(path):
|
|
with open(path, 'r') as f:
|
|
return f.read()
|
|
|
|
|
|
def WrapTextToLineWidth(text, column_width):
|
|
result = ''
|
|
pos = 0
|
|
while pos < len(text):
|
|
result += text[pos : pos + column_width] + '\n'
|
|
pos += column_width
|
|
return result
|
|
|
|
|
|
def EncodeDataForPem(data):
|
|
result = base64.b64encode(data)
|
|
return WrapTextToLineWidth(result, 75)
|
|
|
|
|
|
class PemBlock(object):
|
|
def __init__(self):
|
|
self.name = None
|
|
self.data = None
|
|
self.comment = None
|
|
|
|
|
|
def StripAllWhitespace(text):
|
|
pattern = re.compile(r'\s+')
|
|
return re.sub(pattern, '', text)
|
|
|
|
|
|
def IsEntirelyWhiteSpace(text):
|
|
return len(StripAllWhitespace(text)) == 0
|
|
|
|
|
|
def DecodePemBlockData(text):
|
|
text = StripAllWhitespace(text)
|
|
return base64.b64decode(text)
|
|
|
|
|
|
def GetPemBlocks(data):
|
|
"""Returns an iterable of PemBlock"""
|
|
|
|
regex = re.compile(r'-----BEGIN ([\w ]+)-----(.*?)-----END \1-----',
|
|
re.DOTALL)
|
|
|
|
for match in regex.finditer(data):
|
|
block = PemBlock()
|
|
|
|
block.name = match.group(1)
|
|
block.data = DecodePemBlockData(match.group(2))
|
|
|
|
# Keep track of any non-PEM text between blocks
|
|
block.comment = GetTextUntilNextPemBlock(data[match.end():])
|
|
|
|
yield block
|
|
|
|
|
|
def WriteStringToFile(data, path):
|
|
with open(path, "w") as f:
|
|
f.write(data)
|
|
|
|
|
|
def main():
|
|
for path in GetPemFilePaths():
|
|
print "Processing %s ..." % (path)
|
|
original_data = ReadFileToString(path)
|
|
transformed_data = Transform(original_data)
|
|
if original_data != transformed_data:
|
|
WriteStringToFile(transformed_data, path)
|
|
print "Rewrote %s" % (path)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|