Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix few issues in security BBE descriptions #1826

Merged
merged 1 commit into from
May 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// for authentication, and scopes for authorization.<br/>
// Ballerina uses the concept of scopes for authorization. A resource declared
// in a service can be bound to one/more scope(s).<br/>
// In the authorization phase, the scopes of the service/resource are compared
// In the authorization phase, the scopes of the service are compared
// against the scope included in the user store for at least one match between
// the two sets.<br/>
// `Config.toml` has defined three users - alice, ldclakmal and eve. Each user has a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// authentication, and scopes for authorization.<br/>
// Ballerina uses the concept of scopes for authorization. A resource declared
// in a service can be bound to one/more scope(s).<br/>
// In the authorization phase, the scopes of the service/resource are compared
// In the authorization phase, the scopes of the service are compared
// against the scope included in the user store for at least one match between
// the two sets.<br/><br/>
// For more information on the underlying module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// in a service can be bound to one/more scope(s). The scope can be included
// in the JWT using a custom claim attribute. That custom claim attribute
// also can be configured as the `scopeKey`.<br/>
// In the authorization phase, the scopes of the service/resource are compared
// In the authorization phase, the scopes of the service are compared
// against the scope included in the JWT for at least one match between the two
// sets.<br/><br/>
// For more information on the underlying module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
// in a service can be bound to one/more scope(s). The scope can be included
// in the introspection response using a custom claim attribute. That custom
// claim attribute is also can be configured as the `scopeKey`.<br/>
// In the authorization phase, the scopes of the service/resource are compared
// In the authorization phase, the scopes of the service are compared
// against the scope included in the introspection response for at least one
// match between the two sets.<br/><br/>
// For more information on the underlying module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import ballerina/io;

// An HTTP client can be configured to initiate new connections that are
// secured via mutual SSL.
// The [http:ClientSecureSocket](https://docs.central.ballerina.io/ballerina/http/latest/records/ClientSecureSocket) record provides the SSL-related configurations.
// The [`http:ClientSecureSocket`](https://docs.central.ballerina.io/ballerina/http/latest/records/ClientSecureSocket) record provides the SSL-related configurations.
http:Client securedEP = check new("https://localhost:9090",
secureSocket = {
key: {
Expand All @@ -15,6 +15,7 @@ http:Client securedEP = check new("https://localhost:9090",
name: http:TLS
},
ciphers: ["TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"]

}
);

Expand Down
2 changes: 1 addition & 1 deletion examples/http-client-ssl-tls/http_client_ssl_tls.bal
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import ballerina/io;
// An HTTP client can be configured to communicate through HTTPS as well.
// To secure a client using HTTPS, the client needs to be configured with
// a certificate file of the listener.
// The [http:ClientSecureSocket](https://docs.central.ballerina.io/ballerina/http/latest/records/ClientSecureSocket) record
// The [`http:ClientSecureSocket`](https://docs.central.ballerina.io/ballerina/http/latest/records/ClientSecureSocket) record
// provides the SSL-related configurations of the client.
http:Client securedEP = check new("https://localhost:9090",
secureSocket = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
// In the authorization phase, the scopes of the service/resource are compared
// against the scope included in the user store for at least one match between
// the two sets.<br/>
// `Config.toml` has defined three users - Alice, Bob and Eve. Each user has a
// `Config.toml` has defined three users - alice, ldclakmal and eve. Each user has a
// password and optionally assigned scopes as an array.<br/><br/>
// For more information on the underlying module,
// see the [Auth module](https://docs.central.ballerina.io/ballerina/auth/latest/).
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import ballerina/http;

// An HTTP listener can be configured to accept new connections that are
// secured via mutual SSL.
// The [http:ListenerSecureSocket](https://docs.central.ballerina.io/ballerina/http/latest/records/ListenerSecureSocket) record provides the SSL-related listener configurations.
// The [`http:ListenerSecureSocket`](https://docs.central.ballerina.io/ballerina/http/latest/records/ListenerSecureSocket) record provides the SSL-related listener configurations.
listener http:Listener securedEP = new(9090,
secureSocket = {
key: {
Expand All @@ -21,6 +21,7 @@ listener http:Listener securedEP = new(9090,
},
// Configures the preferred ciphers.
ciphers: ["TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"]

}
);

Expand Down
2 changes: 1 addition & 1 deletion examples/http-service-ssl-tls/http_service_ssl_tls.bal
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import ballerina/http;
// An HTTP listener can be configured to communicate through HTTPS as well.
// To secure an listener using HTTPS, the listener needs to be configured with
// a certificate file and a private key file for the listener.
// The [http:ListenerSecureSocket](https://docs.central.ballerina.io/ballerina/http/latest/records/ListenerSecureSocket) record
// The [`http:ListenerSecureSocket`](https://docs.central.ballerina.io/ballerina/http/latest/records/ListenerSecureSocket) record
// provides the SSL-related listener configurations of the listener.
listener http:Listener securedEP = new(9090,
secureSocket = {
Expand Down