make_errors.go 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412
  1. // Copyright (c) 2014, Google Inc.
  2. //
  3. // Permission to use, copy, modify, and/or distribute this software for any
  4. // purpose with or without fee is hereby granted, provided that the above
  5. // copyright notice and this permission notice appear in all copies.
  6. //
  7. // THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  8. // WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  9. // MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  10. // SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  11. // WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  12. // OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  13. // CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  14. package main
  15. import (
  16. "bufio"
  17. "errors"
  18. "flag"
  19. "fmt"
  20. "io"
  21. "os"
  22. "path/filepath"
  23. "sort"
  24. "strconv"
  25. "strings"
  26. )
  27. // ssl.h reserves values 1000 and above for error codes corresponding to
  28. // alerts. If automatically assigned reason codes exceed this value, this script
  29. // will error. This must be kept in sync with SSL_AD_REASON_OFFSET in ssl.h.
  30. const reservedReasonCode = 1000
  31. var resetFlag *bool = flag.Bool("reset", false, "If true, ignore current assignments and reassign from scratch")
  32. func makeErrors(reset bool) error {
  33. topLevelPath, err := findToplevel()
  34. if err != nil {
  35. return err
  36. }
  37. dirName, err := os.Getwd()
  38. if err != nil {
  39. return err
  40. }
  41. lib := filepath.Base(dirName)
  42. headerPath := filepath.Join(topLevelPath, "include", "openssl", lib+".h")
  43. errDir := filepath.Join(topLevelPath, "crypto", "err")
  44. dataPath := filepath.Join(errDir, lib+".errordata")
  45. headerFile, err := os.Open(headerPath)
  46. if err != nil {
  47. if os.IsNotExist(err) {
  48. return fmt.Errorf("No header %s. Run in the right directory or touch the file.", headerPath)
  49. }
  50. return err
  51. }
  52. prefix := strings.ToUpper(lib)
  53. reasons, err := parseHeader(prefix, headerFile)
  54. headerFile.Close()
  55. if reset {
  56. err = nil
  57. // Retain any reason codes above reservedReasonCode.
  58. newReasons := make(map[string]int)
  59. for key, value := range reasons {
  60. if value >= reservedReasonCode {
  61. newReasons[key] = value
  62. }
  63. }
  64. reasons = newReasons
  65. }
  66. if err != nil {
  67. return err
  68. }
  69. dir, err := os.Open(".")
  70. if err != nil {
  71. return err
  72. }
  73. defer dir.Close()
  74. filenames, err := dir.Readdirnames(-1)
  75. if err != nil {
  76. return err
  77. }
  78. if filepath.Base(filepath.Dir(dirName)) == "fipsmodule" {
  79. // Search the non-FIPS half of library for error codes as well.
  80. extraPath := filepath.Join(topLevelPath, "crypto", lib+"_extra")
  81. extraDir, err := os.Open(extraPath)
  82. if err != nil && !os.IsNotExist(err) {
  83. return err
  84. }
  85. if err == nil {
  86. defer extraDir.Close()
  87. extraFilenames, err := extraDir.Readdirnames(-1)
  88. if err != nil {
  89. return err
  90. }
  91. for _, extraFilename := range extraFilenames {
  92. filenames = append(filenames, filepath.Join(extraPath, extraFilename))
  93. }
  94. }
  95. }
  96. for _, name := range filenames {
  97. if !strings.HasSuffix(name, ".c") && !strings.HasSuffix(name, ".cc") {
  98. continue
  99. }
  100. if err := addReasons(reasons, name, prefix); err != nil {
  101. return err
  102. }
  103. }
  104. assignNewValues(reasons, reservedReasonCode)
  105. headerFile, err = os.Open(headerPath)
  106. if err != nil {
  107. return err
  108. }
  109. defer headerFile.Close()
  110. newHeaderFile, err := os.OpenFile(headerPath+".tmp", os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0666)
  111. if err != nil {
  112. return err
  113. }
  114. defer newHeaderFile.Close()
  115. if err := writeHeaderFile(newHeaderFile, headerFile, prefix, reasons); err != nil {
  116. return err
  117. }
  118. // Windows forbids renaming an open file.
  119. headerFile.Close()
  120. newHeaderFile.Close()
  121. if err := os.Rename(headerPath+".tmp", headerPath); err != nil {
  122. return err
  123. }
  124. dataFile, err := os.OpenFile(dataPath, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)
  125. if err != nil {
  126. return err
  127. }
  128. outputStrings(dataFile, lib, reasons)
  129. dataFile.Close()
  130. return nil
  131. }
  132. func findToplevel() (path string, err error) {
  133. path = ".."
  134. buildingPath := filepath.Join(path, "BUILDING.md")
  135. _, err = os.Stat(buildingPath)
  136. for i := 0; i < 2 && err != nil && os.IsNotExist(err); i++ {
  137. path = filepath.Join("..", path)
  138. buildingPath = filepath.Join(path, "BUILDING.md")
  139. _, err = os.Stat(buildingPath)
  140. }
  141. if err != nil {
  142. return "", errors.New("Cannot find BUILDING.md file at the top-level")
  143. }
  144. return path, nil
  145. }
  146. type assignment struct {
  147. key string
  148. value int
  149. }
  150. type assignmentsSlice []assignment
  151. func (a assignmentsSlice) Len() int {
  152. return len(a)
  153. }
  154. func (a assignmentsSlice) Less(i, j int) bool {
  155. return a[i].value < a[j].value
  156. }
  157. func (a assignmentsSlice) Swap(i, j int) {
  158. a[i], a[j] = a[j], a[i]
  159. }
  160. func outputAssignments(w io.Writer, assignments map[string]int) {
  161. var sorted assignmentsSlice
  162. for key, value := range assignments {
  163. sorted = append(sorted, assignment{key, value})
  164. }
  165. sort.Sort(sorted)
  166. for _, assignment := range sorted {
  167. fmt.Fprintf(w, "#define %s %d\n", assignment.key, assignment.value)
  168. }
  169. }
  170. func parseDefineLine(line, lib string) (key string, value int, ok bool) {
  171. if !strings.HasPrefix(line, "#define ") {
  172. return
  173. }
  174. fields := strings.Fields(line)
  175. if len(fields) != 3 {
  176. return
  177. }
  178. key = fields[1]
  179. if !strings.HasPrefix(key, lib+"_R_") {
  180. return
  181. }
  182. var err error
  183. if value, err = strconv.Atoi(fields[2]); err != nil {
  184. return
  185. }
  186. ok = true
  187. return
  188. }
  189. func writeHeaderFile(w io.Writer, headerFile io.Reader, lib string, reasons map[string]int) error {
  190. var last []byte
  191. var haveLast, sawDefine bool
  192. newLine := []byte("\n")
  193. scanner := bufio.NewScanner(headerFile)
  194. for scanner.Scan() {
  195. line := scanner.Text()
  196. _, _, ok := parseDefineLine(line, lib)
  197. if ok {
  198. sawDefine = true
  199. continue
  200. }
  201. if haveLast {
  202. w.Write(last)
  203. w.Write(newLine)
  204. }
  205. if len(line) > 0 || !sawDefine {
  206. last = []byte(line)
  207. haveLast = true
  208. } else {
  209. haveLast = false
  210. }
  211. sawDefine = false
  212. }
  213. if err := scanner.Err(); err != nil {
  214. return err
  215. }
  216. outputAssignments(w, reasons)
  217. w.Write(newLine)
  218. if haveLast {
  219. w.Write(last)
  220. w.Write(newLine)
  221. }
  222. return nil
  223. }
  224. func outputStrings(w io.Writer, lib string, assignments map[string]int) {
  225. lib = strings.ToUpper(lib)
  226. prefixLen := len(lib + "_R_")
  227. keys := make([]string, 0, len(assignments))
  228. for key := range assignments {
  229. keys = append(keys, key)
  230. }
  231. sort.Strings(keys)
  232. for _, key := range keys {
  233. fmt.Fprintf(w, "%s,%d,%s\n", lib, assignments[key], key[prefixLen:])
  234. }
  235. }
  236. func assignNewValues(assignments map[string]int, reserved int) {
  237. // Needs to be in sync with the reason limit in
  238. // |ERR_reason_error_string|.
  239. max := 99
  240. for _, value := range assignments {
  241. if reserved >= 0 && value >= reserved {
  242. continue
  243. }
  244. if value > max {
  245. max = value
  246. }
  247. }
  248. max++
  249. // Sort the keys, so this script is reproducible.
  250. keys := make([]string, 0, len(assignments))
  251. for key, value := range assignments {
  252. if value == -1 {
  253. keys = append(keys, key)
  254. }
  255. }
  256. sort.Strings(keys)
  257. for _, key := range keys {
  258. if reserved >= 0 && max >= reserved {
  259. // If this happens, try passing -reset. Otherwise bump
  260. // up reservedReasonCode.
  261. panic("Automatically-assigned values exceeded limit!")
  262. }
  263. assignments[key] = max
  264. max++
  265. }
  266. }
  267. func handleDeclareMacro(line, join, macroName string, m map[string]int) {
  268. if i := strings.Index(line, macroName); i >= 0 {
  269. contents := line[i+len(macroName):]
  270. if i := strings.Index(contents, ")"); i >= 0 {
  271. contents = contents[:i]
  272. args := strings.Split(contents, ",")
  273. for i := range args {
  274. args[i] = strings.TrimSpace(args[i])
  275. }
  276. if len(args) != 2 {
  277. panic("Bad macro line: " + line)
  278. }
  279. token := args[0] + join + args[1]
  280. if _, ok := m[token]; !ok {
  281. m[token] = -1
  282. }
  283. }
  284. }
  285. }
  286. func addReasons(reasons map[string]int, filename, prefix string) error {
  287. file, err := os.Open(filename)
  288. if err != nil {
  289. return err
  290. }
  291. defer file.Close()
  292. reasonPrefix := prefix + "_R_"
  293. scanner := bufio.NewScanner(file)
  294. for scanner.Scan() {
  295. line := scanner.Text()
  296. handleDeclareMacro(line, "_R_", "OPENSSL_DECLARE_ERROR_REASON(", reasons)
  297. for len(line) > 0 {
  298. i := strings.Index(line, prefix+"_")
  299. if i == -1 {
  300. break
  301. }
  302. line = line[i:]
  303. end := strings.IndexFunc(line, func(r rune) bool {
  304. return !(r == '_' || (r >= 'A' && r <= 'Z') || (r >= '0' && r <= '9'))
  305. })
  306. if end == -1 {
  307. end = len(line)
  308. }
  309. var token string
  310. token, line = line[:end], line[end:]
  311. switch {
  312. case strings.HasPrefix(token, reasonPrefix):
  313. if _, ok := reasons[token]; !ok {
  314. reasons[token] = -1
  315. }
  316. }
  317. }
  318. }
  319. return scanner.Err()
  320. }
  321. func parseHeader(lib string, file io.Reader) (reasons map[string]int, err error) {
  322. reasons = make(map[string]int)
  323. scanner := bufio.NewScanner(file)
  324. for scanner.Scan() {
  325. key, value, ok := parseDefineLine(scanner.Text(), lib)
  326. if !ok {
  327. continue
  328. }
  329. reasons[key] = value
  330. }
  331. err = scanner.Err()
  332. return
  333. }
  334. func main() {
  335. flag.Parse()
  336. if err := makeErrors(*resetFlag); err != nil {
  337. fmt.Fprintf(os.Stderr, "%s\n", err)
  338. os.Exit(1)
  339. }
  340. }