Skip to content

Commit f37a99c

Browse files
stevencedrostevencedro
committed
refactor(#29): readme and licence updates
1 parent 1f6cc42 commit f37a99c

17 files changed

+95
-29
lines changed

‎.github/workflows/test.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
# Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
114
name: test
215

316
on:

‎.gitignore

+14
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
115
# If you prefer the allow list template instead of the deny list, see community template:
216
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
317
#

‎.vscode/launch.json

+13
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
114
{
215
// Use IntelliSense to learn about possible attributes.
316
// Hover to view descriptions of existing attributes.

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
An implementation of the W3C Web Cryptography API specification (https://www.w3.org/TR/WebCryptoAPI/) for Go using Go's standard `crypto` library.
44

55
> [!IMPORTANT]
6-
> Whilst we try to ensure that we don't commit breaking changes until we release our first stable version, there
6+
> Whilst we try to ensure that we don't commit breaking changes until we release our first major version, there
77
> may be times where decisions made during early development no longer make sense and therefore require
8-
> breaking changes. Please be mindful of this when updating your version of this library until we hit v1.0.0.
8+
> breaking changes. Please be mindful of this when updating your version of this library until we hit `v1.0.0`.
99
1010
## Contents
1111

‎algorithm.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
22

33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -12,6 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
// Package webcrypto implements the WebCrypto API specification (https://www.w3.org/TR/WebCryptoAPI/).
1516
package webcrypto
1617

1718
import "fmt"

‎algorithms/rsa/rsa.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
22

33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -12,8 +12,8 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.package rsa
1414

15-
// Package rsa implements RSA operations as specified in the algorithm overview
16-
// §19 https://www.w3.org/TR/WebCryptoAPI/#algorithm-overview
15+
// Package rsa implements RSA operations;
16+
// RSA-OAEP as specified in §30 (https://www.w3.org/TR/WebCryptoAPI/#rsa-oaep).
1717
package rsa
1818

1919
import (

‎algorithms/rsa/rsa_oaep.go

+16
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
2+
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.package rsa
14+
15+
// Package rsa implements RSA operations;
16+
// RSA-OAEP as specified in §30 (https://www.w3.org/TR/WebCryptoAPI/#rsa-oaep).
117
package rsa
218

319
import (

‎algorithms/rsa/rsa_oaep_test.go

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
22

33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -10,8 +10,10 @@
1010
// distributed under the License is distributed on an "AS IS" BASIS,
1111
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
// See the License for the specific language governing permissions and
13-
// limitations under the License
13+
// limitations under the License.package rsa
1414

15+
// Package rsa implements RSA operations;
16+
// RSA-OAEP as specified in §30 (https://www.w3.org/TR/WebCryptoAPI/#rsa-oaep).
1517
package rsa
1618

1719
import (

‎algorithms/sha/sha.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
22

33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

‎algorithms/sha/sha_test.go

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
22

33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -12,6 +12,8 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
// Package sha implements the SHA operations as specified in
16+
// §30 (https://www.w3.org/TR/WebCryptoAPI/#sha)
1517
package sha
1618

1719
import (

‎crypto.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
22

33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -12,6 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
// Package webcrypto implements the WebCrypto API specification (https://www.w3.org/TR/WebCryptoAPI/).
1516
package webcrypto
1617

1718
import (

‎crypto_key.go

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
// Package webcrypto implements the WebCrypto API specification (https://www.w3.org/TR/WebCryptoAPI/).
1516
package webcrypto
1617

1718
type KeyUsage string

‎errors.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
22

33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -12,6 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
// Package webcrypto implements the WebCrypto API specification (https://www.w3.org/TR/WebCryptoAPI/).
1516
package webcrypto
1617

1718
import (

‎format.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
22

33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -12,6 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
// Package webcrypto implements the WebCrypto API specification (https://www.w3.org/TR/WebCryptoAPI/).
1516
package webcrypto
1617

1718
type KeyFormat string

‎go.mod

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
2+
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
114
module github.com/armortal/webcrypto-go
215

3-
go 1.20
16+
go 1.22.2
417

518
require github.com/google/uuid v1.3.0

‎subtle.go

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
// Package webcrypto implements the WebCrypto API specification (https://www.w3.org/TR/WebCryptoAPI/).
1516
package webcrypto
1617

1718
// SubtleCrypto interface provides a set of methods for dealing with low-level cryptographic primitives and

‎util/util_test.go

+2-15
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,4 @@
1-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
2-
3-
// Licensed under the Apache License, Version 2.0 (the "License");
4-
// you may not use this file except in compliance with the License.
5-
// You may obtain a copy of the License at
6-
7-
// http://www.apache.org/licenses/LICENSE-2.0
8-
9-
// Unless required by applicable law or agreed to in writing, software
10-
// distributed under the License is distributed on an "AS IS" BASIS,
11-
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12-
// See the License for the specific language governing permissions and
13-
// limitations under the License.
14-
15-
// Copyright 2023 ARMORTAL TECHNOLOGIES PTY LTD
1+
// Copyright 2023-2024 ARMORTAL TECHNOLOGIES PTY LTD
162

173
// Licensed under the Apache License, Version 2.0 (the "License");
184
// you may not use this file except in compliance with the License.
@@ -26,6 +12,7 @@
2612
// See the License for the specific language governing permissions and
2713
// limitations under the License.
2814

15+
// Package util contains utility functions.
2916
package util
3017

3118
import (

0 commit comments

Comments
 (0)